Skip to content
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

Merged
merged 4 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@ saleor-sdk tools encode-id User 22

## Development

To contribute to this repository you will need Hatch to setup a local development environment.

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:
Copy link
Contributor

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:

  1. Run the blow command to start a dev server with the documentation site:
  2. (below the code) Dev server provides a live reload on changes and lets you preview the site after it's published.


```
hatch run docs:serve
```
Expand All @@ -42,20 +46,27 @@ and navigate to http://127.0.0.1:8000

### Tests

With the following command you can run tests:
pkucmus marked this conversation as resolved.
Show resolved Hide resolved

```
hatch run test
```

### Build and deploy
### Code style
pkucmus marked this conversation as resolved.
Show resolved Hide resolved

This library follows a specific style guide, to achieve the proper format and lint the code the following commands should be used:
pkucmus marked this conversation as resolved.
Show resolved Hide resolved

```
hatch build -c
hatch publish
hatch run lint:fmt
hatch run lint:all
```

### Code style

### Build and deploy

This is done by a CI/CD workflow upon the creation of a release but in case of the need for a manual publication of the packager to PyPI you need to build the package archive and publish it.
rafalp marked this conversation as resolved.
Show resolved Hide resolved
KarolJagodzinski marked this conversation as resolved.
Show resolved Hide resolved

```
hatch run lint:fmt
hatch run lint:all
hatch build -c
hatch publish
```
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ pip install saleor-sdk-python

## Key features
Copy link
Contributor

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".

Copy link
Contributor

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


- CLI with tooling that helps to decode Saleor IDs
- Crypto module helping with Saleor authentication, both JWT verification and webhook signature verification
- CLI with tooling that helps to decode and encode Saleor IDs - this is useful when a entity type or ID needs to be recognized from a GraphQL ID
pkucmus marked this conversation as resolved.
Show resolved Hide resolved
- Crypto module helping with Saleor authentication, both JWT verification and webhook signature verification - provides a way to manage Saleor issued signatures
- Marina module - more on that in a later time...

## Best served with
Expand Down