docs: add quick start guide and glossary from learning-fromager repo #898
Conversation
This file contains hidden or 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
Member
|
@shifa-khan I am adding the glossary in a separate PR #884 |
| The ``-c`` option ensures fromager uses exactly the versions you specify. | ||
|
|
||
| Next Steps |
Member
There was a problem hiding this comment.
I like this. Once you remove glossary, we can merge this.
Contributor
Author
There was a problem hiding this comment.
Made changes as requested.
shifa-khan
force-pushed
the
799
branch
2 times, most recently
from
2db6e21 to
0ddf740
Compare
LalatenduMohanty
requested changes
Dec 23, 2025
| :maxdepth: 2 | ||
|
|
||
| using.md | ||
| quickstart.rst |
Member
There was a problem hiding this comment.
Please keep quickstart.rst before using.md for users scanning the documentation. A "Quick Start" is typically the first thing new users look for.
Add quickstart.rst with installation instructions and a simple stevedore example for new users. Update getting-started.rst to point new users to the quick start guide. Content adapted from the learning-fromager repository. Signed-off-by: shifa-khan [email protected] Closes: python-wheel-build#799
Member
|
Looks good to me. @dhellmann You might want to take a look as well. Will wait for your review for a day (for lazy consensus) else going to merge this. |
LalatenduMohanty
approved these changes
Jan 5, 2026
LalatenduMohanty
merged commit bfdda7e
into
python-wheel-build:main
47 of 48 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add quickstart.rst with installation instructions and a simple stevedore example for new users. Add glossary.md with terminology definitions. Update getting-started.rst to point new users to the quick start guide.
Content adapted from the learning-fromager repository.
Signed-off-by: shifa-khan [email protected]
Closes: #799