Skip to content

Conversation

@ishan372or
Copy link

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other (documentation reorganization)

Why is this PR needed?

From a new user’s perspective, the Get Started section is longer than necessary and slightly out of order.
The “Set up a project” guide is fairly detailed and fits better under User Guides, while the
Walkthrough already serves as a natural entry point and points users toward installation.

This change aligns with the discussion in #616 and improves the onboarding flow.

What does this PR do?

  • Moves “Set up a project” from Get Started to User Guides
  • Reorders Get Started so Walkthrough appears before Install
  • Updates sidebar navigation and section intro text accordingly
  • No changes to the guide content itself

References

How has this PR been tested?

  • Built the documentation locally using Sphinx
  • Verified sidebar navigation, ordering, and active state for affected pages
  • Checked for broken links or rendering issues after the reorganization

Is this a breaking change?

No. This PR only affects documentation structure and navigation.

Does this PR require an update to the documentation?

Yes. This PR reorganizes existing documentation to improve clarity and onboarding.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit (not applicable for docs-only changes)

@ishan372or
Copy link
Author

Hi @JoeZiminski, I’ve reorganized the docs by moving “Set up a project” into User Guides and reordering the Get Started section so the walkthrough comes first.

Please let me know if this structure looks good to you, or if you’d prefer any adjustments.

@ishan372or ishan372or changed the title fixed docs docs: reorganize Get Started and User Guides Dec 21, 2025
@JoeZiminski
Copy link
Member

Thanks a lot for this @ishan372or, I built it locally and it looks great. I will get feedback from other team members on 14th Jan on the new layout, and then (assuming no other suggestions) this will be good to go. Thanks!

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