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: Simplify the top level of documentation #2995

Merged
merged 12 commits into from
Jul 30, 2024
Merged

Conversation

claremacrae
Copy link
Collaborator

Types of changes

Changes visible to users:

  • Documentation (prefix: docs - improvements to any documentation content for users)

Description

Some small rearrangements to the user docs to:

  • Reduce the number of pages in the top-level
  • Simplify the Introduction page.

All but the last few changes were made jointly in a pairing session with @aubreyz, who spotted the potential for improvements.

Motivation and Context

See:

How has this been tested?

  • By reviewing the edits in Obsidian
  • By publishing the pages to check the effect.

Screenshots (if appropriate)

Checklist

  • My code follows the code style of this project and passes yarn run lint.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Terms

claremacrae and others added 12 commits July 30, 2024 21:59
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Deleted relic of What's New from Introduction page

Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
Changelog links to Breaking Changes

Co-Authored-By: aubreyz <25100168+aubreyz@users.noreply.github.com>
@claremacrae claremacrae added the scope: documentation Improvements or additions to documentation label Jul 30, 2024
Copy link

sonarcloud bot commented Jul 30, 2024

@claremacrae
Copy link
Collaborator Author

Note that at some point I stopped adding links to the following page, as it was slowing us down:

contributing/Documentation/Redirects - Testing old links still work.md

However, old links to all the moved and removed pages will still work, due to the addition of aliases.

@claremacrae claremacrae merged commit 3207040 into main Jul 30, 2024
3 checks passed
@claremacrae claremacrae deleted the docs-simplify-top-level branch July 30, 2024 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant