docs: add getting started section #3818
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boring-cyborg
bot
added
the
documentation
pull-request-size
bot
added
the
size/XXL
dreamorosi
force-pushed
the
docs/getting_started
branch
from
1e83d51 to
b670230
Compare
phipag
reviewed
Apr 11, 2025
phipag
approved these changes
Apr 11, 2025
am29d
requested changes
Apr 14, 2025
am29d
approved these changes
Apr 15, 2025
leandrodamascena
approved these changes
Apr 15, 2025
There was a problem hiding this comment.
Hi @dreamorosi! This is great work and I'm sure it will inspire me to refactor Python documentation.
I just left 2 small comments, but feel free to ignore.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
This PR overhauls and simplifies the entry-section and menu structure of the docs to create a more cohesive onboarding experience for those who are new to the project.
Specifically:
tsconfig.jsonNote
For an easier review, I have deployed this version of the docs at this preview link. If some paths don't load correctly, please checkout the branch and run locally.
Issue number: closes #3799, closes #2948
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.