-
Notifications
You must be signed in to change notification settings - Fork 18
Description
I don't know how to describe this in a short title, so this is the idea:
Currently, there's a fair amount of guesswork in how to fill the guideline submission form, such that the resulting guideline document renders correctly by the end.
It would be amazing to have some documentation, ideally with examples, of how the text we enter in the forms gets converted to the sphinx document and then later rendered.
This is a need I ran into whilst writing #156. Inside the Rationale item, I needed to explain two different and important reasons for the guideline and thus, I needed to use headings (markdown's #, ##, ###
, ie html's <h1>, <h2>, <h3>
, etc.). A couple of questions arose: which headings are appropriate to use? Will the headings I used conform to the hierarchy of the document that contains them, or will they disrupt the surrounding structure? And, I really don't know. I would love to have this in documentation, so that this is something one can know whilst filling the form :)
Metadata
Metadata
Assignees
Labels
Type
Projects
Status