Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Create documentation guidelines #1

Closed
2 tasks done
kianenigma opened this issue May 1, 2023 · 4 comments · Fixed by paritytech/substrate#14115
Closed
2 tasks done

Create documentation guidelines #1

kianenigma opened this issue May 1, 2023 · 4 comments · Fixed by paritytech/substrate#14115
Assignees
Labels
infra issue does not require specific knowledge of the content, and is mainly about the system.

Comments

@kianenigma
Copy link
Collaborator

kianenigma commented May 1, 2023

Main tasks:

@hummusonrails
Copy link

I'm "assigning" this to @aaronbassett to help think through as the FRAME developer pathway expert in our team. I'm also assigning it to myself as someone who's done a lot on docs in general, even though not FRAME specifically.

@hummusonrails
Copy link

What do we want the final output of this to be? A markdown doc outlining the guidelines for writing FRAME docs -- the things that they ought to have, must have, and ought not and must not have?

@kianenigma
Copy link
Collaborator Author

What do we want the final output of this to be? A markdown doc outlining the guidelines for writing FRAME docs -- the things that they ought to have, must have, and ought not and must not have?

Correct. a few pieces:

  1. General documentation guide-lines.
  2. A rough template of how to apply that to FRAME pallets, because they are so important.
  3. We put this somewhere in the how to contribute guide.
  4. We put this in the PR template that @sacha-l is building
  5. This will be our yardstick when policing other PRs :D

I am writing initial versions of all of the above; feel free to comment.

@kianenigma kianenigma changed the title Create FRAME documentation guidelines Create documentation guidelines May 5, 2023
@kianenigma kianenigma added the infra issue does not require specific knowledge of the content, and is mainly about the system. label May 8, 2023
@sacha-l
Copy link

sacha-l commented May 15, 2023

My suggestions for a new PR template: paritytech/substrate#14148

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
infra issue does not require specific knowledge of the content, and is mainly about the system.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants