Skip to content

Conversation

@shifa-khan
Copy link

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 shikhan@redhat.com
Closes: #799

@LalatenduMohanty
Copy link
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this. Once you remove glossary, we can merge this.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made changes as requested.

@shifa-khan shifa-khan force-pushed the 799 branch 2 times, most recently from 2db6e21 to 0ddf740 Compare December 23, 2025 18:50
:maxdepth: 2

using.md
quickstart.rst
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 shikhan@redhat.com
Closes: python-wheel-build#799
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.

Add practical examples to fromager documentation

2 participants