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

Restructures documentation reference section #214

Merged
merged 1 commit into from
Jul 5, 2023
Merged

Restructures documentation reference section #214

merged 1 commit into from
Jul 5, 2023

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Jul 5, 2023

This section was getting unwieldly. It is now
less overwhelming. This will be better for SEO too.

Changes

  1. breaks things out into explicit files
  2. changes the sphinx build to be htmlDir
  3. removes some to be organized docs
  4. fixes up a few typos
  5. fixes links to match new structure

How I tested this

  • Locally

Notes

  • this should help with SEO.

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

This section was getting unwieldly. It is now
less overwhelming.

This change does a few things:
1. breaks things out into explicit files
2. changes the sphinx build to be htmlDir to get rid of pesky .html in the URL
3. removes some to be organized docs
4. fixes up a few typos
5. fixes links to match new structure
@skrawcz skrawcz marked this pull request as ready for review July 5, 2023 07:47
@skrawcz skrawcz merged commit 828e5d7 into main Jul 5, 2023
@skrawcz skrawcz deleted the rework-docs branch July 5, 2023 07:47
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.

1 participant