add index page for docs #14
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
rafalp
reviewed
Jan 9, 2024
rafalp
reviewed
Jan 9, 2024
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.
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ń <rafio.xudb@gmail.com>
rafalp
reviewed
Jan 10, 2024
rafalp
reviewed
Jan 10, 2024
| pip install saleor-sdk-python | ||
| ``` | ||
|
|
||
| ## Key features |
There was a problem hiding this comment.
I would consider dropping this part and moving 2-3 most important things from this to "introduction".
There was a problem hiding this comment.
Decided to keep it here.
However when we will introduce docs for marina then we will decide to move it to introduction
rafalp
approved these changes
Feb 6, 2024
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.
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.