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

feat(doc): move most md doc to docs dir #250

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ The diagram represents the main components of the software and how they interact

## Running

For users who just want to give it a try, please refer to [Quick Start →](./QUICK_START.md), which will guide you through how to interact with existing projects deployed on staging.
For users who just want to give it a try, please refer to [Quick Start →](./docs/QUICK_START.md), which will guide you through how to interact with existing projects deployed on staging.

Developers looking to build circuits and deploy W3bstream projects should consult the [DEVELOPER_GUIDE →](./DEVELOPER_GUIDE.md)
Developers looking to build circuits and deploy W3bstream projects should consult the [DEVELOPER_GUIDE →](./docs/DEVELOPER_GUIDE.md)

Developers who want to run a Sprout node could refer to the [OPERATOR_GUIDE →](./OPERATOR_GUIDE.md)
Developers who want to run a Sprout node could refer to the [OPERATOR_GUIDE →](./docs/OPERATOR_GUIDE.md)


## Contributing

We welcome contributions! Please read our contributing guidelines and submit pull requests to our GitHub repository.
We welcome contributions! Please read our [contributing guidelines](./docs/CONTRIBUTING.md) and submit pull requests to our GitHub repository.

## Community and Support

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions RUN-LOCALLY.md → docs/RUN-LOCALLY.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ ioctl ws project --contract-address $PROJECT_REGISTER_CONTRACT_ADDR create --pro
ioctl ws project --contract-address $PROJECT_REGISTER_CONTRACT_ADDR update --project-id $PROJECT_ID --project-config-file path/to/project_config_file --project-config-hash ${project config sha256 hash(optional)}
```


### Query project

```sh
Expand Down