-
Notifications
You must be signed in to change notification settings - Fork 1
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
add index page for docs #14
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs need more "why" answers to be helpful:
Saleor ID encoding
-> decode-id and encode id utilities are provided for quick conversion of items IDs from and to the GraphQL.
Install Hatch
-> Install Hatch to run developer utilities:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions
README.md
Outdated
Install [Hatch](https://hatch.pypa.io/latest/install/#pipx). | ||
|
||
### Documentation | ||
|
||
You can deploy a local documentation service, it reloads changes and allow for a live preview of how the documentation will look like after publication: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This quite a busy sentence. Lets split it into two:
- Run the blow command to start a dev server with the documentation site:
- (below the code) Dev server provides a live reload on changes and lets you preview the site after it's published.
Co-authored-by: Rafał Pitoń <[email protected]>
pip install saleor-sdk-python | ||
``` | ||
|
||
## Key features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would consider dropping this part and moving 2-3 most important things from this to "introduction".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Decided to keep it here.
However when we will introduce docs for marina then we will decide to move it to introduction
We're missing the index of the documentation page. This is to add one even if it's simple. I also added link to Mirumee.