Skip to content

Commit f7dc02d

Browse files
committed
Update README.md with new documentation link and add initial documentation structure
1 parent 5ab2b3a commit f7dc02d

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The access token will be in a header like:
5757

5858
## Documentation
5959

60-
For detailed documentation, please visit [our docs](docs/).
60+
For detailed documentation, please visit **[chipadevteam.github.io/StakeAPI](https://chipadevteam.github.io/StakeAPI/)**.
6161

6262
## Contributing
6363

docs/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# StakeAPI Documentation
2+
3+
This directory contains the full StakeAPI documentation site, built with Jekyll and the [just-the-docs](https://just-the-docs.github.io/just-the-docs/) theme.
4+
5+
## Viewing the Docs
6+
7+
The documentation is automatically deployed to GitHub Pages when changes are pushed to the `main` branch.
8+
9+
**Live site:** [https://chipadevteam.github.io/StakeAPI/](https://chipadevteam.github.io/StakeAPI/)
10+
11+
## Building Locally
12+
13+
```bash
14+
cd docs
15+
bundle install
16+
bundle exec jekyll serve
17+
```
18+
19+
Then open `http://localhost:4000/StakeAPI/` in your browser.
20+
21+
## Structure
22+
23+
- `getting-started/` — Installation, authentication, quick start
24+
- `guides/` — In-depth guides for all features
25+
- `api-reference/` — Complete API documentation
26+
- `resources/` — Examples, FAQ, troubleshooting, changelog
27+
- `_includes/` — Reusable HTML components (affiliate banners)
28+
- `_config.yml` — Jekyll site configuration
29+
- `sitemap.xml` — Sitemap for search engines
30+
31+
## Sign Up
32+
33+
**[Create your Stake.com account →](https://stake.com/?c=WY7953wQ)**

0 commit comments

Comments
 (0)