-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for Markdown headings used in spec generation #867
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch @bact
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure if we want to spend time trying to define everything.
We definitely need to also address multi-lingual content (maybe not right now, but in the future).
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@zvr - Are you OK with merging this? From the tech call, we felt there was value in documenting this for those doing localization / internationalization for the model. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure we should leave a "Blah" in the text, but rest looks fine.
Signed-off-by: Arthit Suriyawongkul <[email protected]>
I'll review it in detail later this week, but it would be nice to define what our (long-term?) goal will be, @kestewart @goneall . If we are to produce another PDF version, then my suggestion would be to limit the markdown that can be used, since currently I need to manually change some stuff to produce the PDF. If, on the other hand, we only care about the website (HTML version), then it's perfectly fine to leave "allow everything", as long as it renders fine. From a quick look, we could add info on:
|
Add a documentation about headings and formatting used in Markdown files for the specification generation.
This will allow contributors to better familiarise with the format that is expected from the spec-parser.
If there is an update in the spec-parser, this document should be updated as well.
Information about specific formatting to support localization can be added in the future.