Skip to content

Conversation

jhradilek
Copy link
Contributor

@jhradilek jhradilek commented Apr 9, 2025

redhat-documentation/modular-docs#236 introduced a few changes to the structure and the comments in the official templates. This commit carries these changes over to newdoc with a few notable adjustments:

  • I unified the empty space above and below the comment blocks. The upstream version is very inconsistent.
  • I unified the type of comments. The upstream version occasionally switches to line comments for no reason.
  • I moved the _mod-docs-content-type attribute definition in the assembly template to the top to match its position in the other templates.
  • I removed accidental leading spaces from some of the comments.

@jhradilek jhradilek changed the title WIP: Updated the templates to match the official ones. WIP: Update the templates to match the official ones Apr 9, 2025
redhat-documentation/modular-docs#236 introduced
a few changes to the structure and the comments in the official
templates. This commit carries these changes over to newdoc with a few
notable adjustments:

  * I unified the empty space above and below the comment blocks. The
    upstream version is very inconsistent.
  * I unified the type of comments. The upstream version occasionally
    switches to line comments for no reason.
  * I moved the _mod-docs-content-type attribute definition in the
    assembly template to the top to match its position in the other
    templates.
  * I removed accidental leading spaces from some of the comments.
@jhradilek jhradilek changed the title WIP: Update the templates to match the official ones Update the templates to match the official ones Apr 9, 2025
@jhradilek
Copy link
Contributor Author

I think the choices I made accidentally address issue #42.

@mmuehlfeldRH mmuehlfeldRH merged commit 7ffd020 into redhat-documentation:main Apr 10, 2025
@mmuehlfeldRH
Copy link
Collaborator

Thanks for the updated templates.

The changes are part of newdoc 2.18.4.

@jhradilek jhradilek deleted the update-templates branch May 27, 2025 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants