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

Revise home page text, remove unnecessary docs, make new category for status code docs #236

Merged
merged 6 commits into from
May 7, 2024

Conversation

josh-wong
Copy link
Member

Description

This PR updates links, removes unnecessary docs, and makes status code docs a category in the sidebar navigation. The docs that have been removed are ones that we had as indexes since our previous docs site didn't have collapsible categories in the sidebar navigation.

Related issues and/or PRs

N/A

Changes made

  • Revised the text in the Cards on the home page.
  • Added status code docs to a collapsible category in the sidebar navigation.
  • Removed unnecessary index docs.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

josh-wong added 6 commits May 7, 2024 19:37
This doc was used as a redirect for our Jekyll site. Since the page has very few views, I think it's safe to delete it. If we need to add a redirect for this page int he future for some reason, we'll need to use the redirect plugin in Docusaurus instead.
This doc can be removed since we can now put docs inside collapsible categories in the sidebar navigation.
@josh-wong josh-wong added the documentation Improvements or additions to documentation label May 7, 2024
@josh-wong josh-wong self-assigned this May 7, 2024
@josh-wong josh-wong merged commit 9326fe5 into main May 7, 2024
1 check passed
@josh-wong josh-wong deleted the update-links-and-remove-unnecessary-docs branch May 7, 2024 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant