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.

Sign up for GitHub

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

Jump to bottom

maint: Generate docs better suited to docs team prefs #713

Merged
merged 1 commit into from
Jun 12, 2023
Merged

maint: Generate docs better suited to docs team prefs #713

merged 1 commit into from
Jun 12, 2023

Conversation

kentquirk
Copy link
Contributor

Which problem is this PR solving?

This tweaks the docs generation code to create documents that are closer to the needs of the docs team.

Short description of the changes

  • Helper function to generate one line per sentence in generated docs
  • Use the helper function
  • Reformat the preamble of the rules file
  • Regenerate the docs (most of the changed lines are in the .md files)

@kentquirk kentquirk requested a review from a team as a code owner June 12, 2023 18:53
@kentquirk kentquirk added this to the v2.0 milestone Jun 12, 2023
@kentquirk kentquirk merged commit caa95a0 into main Jun 12, 2023
@kentquirk kentquirk deleted the kent.docs_cleanup branch June 12, 2023 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TylerHelmuth TylerHelmuth TylerHelmuth approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.0
Development

Successfully merging this pull request may close these issues.
2 participants
@kentquirk @TylerHelmuth