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

docs: Improve generated documentation #711

Merged
merged 6 commits into from
Jun 12, 2023
Merged

docs: Improve generated documentation #711

merged 6 commits into from
Jun 12, 2023

Conversation

kentquirk
Copy link
Contributor

Which problem is this PR solving?

  • This improves the documentation templates so the generated documentation is better-formatted, easier to read, and generally more usable. It also moves the generated docs into the root folder.
  • It's not really as big as it might look -- the template files got revised and then the files were regenerated and moved.
  • A few tweaks were made to code and the metadata to eliminate redundancy.

Short description of the changes

  • Revise templates to explain more upfront
  • Add example to each template
  • Add table of contents so the file is more referenceable
  • Add $ reference capability to rules data to eliminate redundant descriptions in the rules metadata file

@kentquirk kentquirk requested a review from a team as a code owner June 10, 2023 23:53
@kentquirk kentquirk added this to the v2.0 milestone Jun 10, 2023
Copy link
Contributor

@TylerHelmuth TylerHelmuth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use this opportunity to throw in a generated on timestamp to all the generated files?

@kentquirk kentquirk requested a review from TylerHelmuth June 12, 2023 16:00
@kentquirk kentquirk merged commit 377353f into main Jun 12, 2023
@kentquirk kentquirk deleted the kent.rules_docs branch June 12, 2023 16:55
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