Skip to content
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

Chapter 7.5 asset schema: different markdown heading sizes and no capital letter? #349

Closed
AsamDiegoSanchez opened this issue Jan 30, 2025 · 4 comments
Assignees
Labels
isType:Editorial An issue that contains general structural and editorial changes
Milestone

Comments

@AsamDiegoSanchez
Copy link
Member

Is your feature request related to a problem? Please describe.

In the chapter 7.5 asset schema the content is automatically generated, but the sub-sections are written in lowercase, according to the Editorial guide should start with capital letter (https://internal.pages.asam.net/asam-editorial-guide/editorial-guide-generator/editorialguide-asciidoc/1.0.0/Editorial_guide/05_headings.html)

Image

Also I can appreciate different sub-titles sizes:

see: frontAxle and maxsteering

Image

Describe the solution you'd like

Correct the capital letter on each subsection.

Check the sub-title letter sizes to be consistent

Check other generated content in the document which might have the same problems.

@AsamDiegoSanchez AsamDiegoSanchez added the isType:Editorial An issue that contains general structural and editorial changes label Jan 30, 2025
@AsamDiegoSanchez AsamDiegoSanchez added this to the v1.0.0 milestone Jan 30, 2025
@AsamDiegoSanchez
Copy link
Member Author

@ClemensLinnhoff is this something that could be solved modifying the schemas?

@ClemensLinnhoff
Copy link
Collaborator

I think we have to deviate from the editorial guide here since the schema chapters accurately represent the actual schema files. According to the JSON convention, all fields in the schemas are written in lowerCamelCase. So I would prefer if we could keep the same naming in the documentation.

The subtitle sizes are automatically set by the antora (or asciidoctor) template. In the files it is just plain ASCIIdoc with no additional formatting.

@AsamDiegoSanchez
Copy link
Member Author

Ok, I understand, let me discuss it internally

@FKlopfer FKlopfer assigned AsamDiegoSanchez and unassigned FKlopfer Feb 4, 2025
@AsamDiegoSanchez
Copy link
Member Author

Feedback: If the text is actually representing code elements or attributes, then deviation from the editorial guide is accepted. These are subject to the formatting rules for said elements.
Issues can be closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
isType:Editorial An issue that contains general structural and editorial changes
Projects
None yet
Development

No branches or pull requests

3 participants