This website is built using Docusaurus, a modern static website generator.

npm install

To preview your changes as you edit the files, you can run a local development server that will serve your website and reflect the latest changes.

npm run start

By default, a browser window will open at http://localhost:3000.

Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available.

Docusaurus is a modern static website generator so we need to build the website into a directory of static contents and put it on a web server so that it can be viewed. To build the website:

npm run build

and contents will be generated within the /build directory, which can be copied to any static file hosting service like GitHub pages, Vercel or Netlify. Check out the docs on deployment for more details.

There are many ways to update your Docusaurus version. One guaranteed way is to manually change the version number in package.json to the desired version. Note that all @docusaurus/-namespaced packages should be using the same version.

{
  "dependencies": {
    "@docusaurus/core": "3.1.1",
    "@docusaurus/preset-classic": "3.1.1",
    // ...
  }
}

Then, in the directory containing package.json, run your package manager's install command:

npm install

To check that the update occurred successfully, run:

npx docusaurus --version

You should see the correct version as output.

Alternatively, if you are using Yarn, you can do:

yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest

• Community docs and plugins
• Use new unreleased features of Docusaurus with the @canary npm dist tag

Ask for help on Stack Overflow, on our GitHub repository, our Discord server, or Twitter.

This Docusaurus site publishes AI-friendly files from static/ into public URLs. Keep these files under the staking-api prefix when they are specific to the Stakely Staking API.

Public AI entry points:

• Global LLM router: https://docs.stakely.io/llms.txt (static/llms.txt)
• Staking API full LLM context: https://docs.stakely.io/staking-api/llms-full.txt (static/staking-api/llms-full.txt)
• Staking API AI guide, raw Markdown: https://docs.stakely.io/staking-api/ai-integration-guide.md (static/staking-api/ai-integration-guide.md)
• Staking API AI guide, docs page: https://docs.stakely.io/staking-api/ai-integration-guide (docs/staking-api/ai-integration-guide.md)
• Staking API OpenAPI schema: https://staking-api.stakely.io/openapi.json

When updating the visible AI guide, mirror the content into static/staking-api/ai-integration-guide.md so LLMs can fetch a stable raw Markdown file.