Skip to content
Merged
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
43 changes: 43 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Agent Playbook

## Repository Snapshot

- Documentation site built with Next.js 13 and Nextra (`pages/` holds `.mdx` content, `_meta.json` defines navigation order).
- Key scripts: `npm run dev`, `npm run build`, `npm run start`, `npm run lint`.
- Node.js 22 is available; Python execution may be blocked in this environment.

## Workflow Guidelines

- Default to `apply_patch` for hand edits; avoid bulk formatters unless requested.
- Keep additions ASCII unless the surrounding file already uses Unicode.
- Preserve any pre-existing local changes; never revert files you did not modify for the current task.
- When touching documentation directories, update the sibling `_meta.json` so every `.mdx`/`.md` page appears in the navigation.
- Comment only when clarification is essential—most prose and code should remain self-explanatory.

## Documentation Style

- Organize content according to the [Diátaxis](https://diataxis.fr/) framework: Tutorials (learning-oriented), How-to guides (goal-oriented), Explanations (understanding-oriented), and Reference (information-oriented).
- Tutorials: guide the reader through a concrete end-to-end task; assume no prior knowledge, provide step-by-step instructions, and postpone theory until after success.
- How-to guides: focus on achieving a specific outcome; start with prerequisites, list concise actionable steps, and limit background details to what is essential for completing the task.
- Explanations: clarify concepts, trade-offs, and rationale; connect ideas, reference related materials, and avoid procedural instructions.
- Reference: present facts, APIs, configuration tables, and schemas; structure information for quick lookup with consistent formatting and terminology.
- Match the existing section type when editing; move or split content if it drifts outside the intended Diátaxis category.
- Lead with user needs, keep paragraphs short, and surface actionable steps early for tutorials and how-to guides.
- Use consistent terminology across related pages; prefer active voice and second person.
- Include code snippets or command blocks only when they advance the user goal for that section type.

## Command & Sandbox Notes

- Run shell commands through `bash -lc` and always set the `workdir` argument (usually the repo root).
- Network access is restricted; prefer local data. Use `rg` for searching.
- Destructive git commands (`reset --hard`, `checkout --`) are off limits unless the user explicitly requests them.

## Validation

- Run `npm run lint` after significant content or component changes when feasible.
- For structural documentation edits, double-check rendered navigation by restarting the docs dev server if already running.

## Deliverables

- Summaries should state what changed and reference file paths with line numbers when practical.
- Suggest logical follow-up actions (tests, builds, deploy checks) when they help the user.
20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ This repository contains interactive documentation for the [Pyth Network](https:

## Documentation Format

### Interactive components

The interactive components on each page use a shared-key value store to communicate with each other.
This key-value store is

## Local Development

First, run `npm i` to install the dependencies.
Expand All @@ -27,21 +22,6 @@ docker run -d -p 3000:3000 documentation

Then navigate to localhost:3000 in the browser.

## Tests
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these don't exist anymore


Simply run `npm run test`.

The tests include a compiler check for all code snippets written in .mdx files. These tests will automatically extract
the relevant snippets into separate files under the `.code_tests` folder (ignored by git) and then try to build each one.
The files are named per the file path to the code snippet.
These files remain after the tests complete, which allows you to examine them to help debug the error in case a test fails.

You can also run the code tests for a specific mdx file using:

```
npm run test -- -t get-price.mdx
```

## License

This project is derived from the [Nextra Docs Template](https://github.com/shuding/nextra-docs-template).
Expand Down
3 changes: 2 additions & 1 deletion pages/home/oracle-integrity-staking/_meta.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"mathematical-representation": "Mathematical Representation",
"reward-examples": "Reward Examples",
"slashing-rulebook": "Slashing Rulebook"
"slashing-rulebook": "Slashing Rulebook",
"publisher-quality-ranking": "Publisher Quality Ranking"
}
1 change: 1 addition & 0 deletions pages/price-feeds/core/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"push-feeds": "Push Feeds",
"market-hours": "Market Hours",
"best-practices": "Best Practices",
"rate-limits": "Rate Limits",
"error-codes": "Error Codes",
"api-instances-and-providers": "API Instances and Providers",
"contract-addresses": "Contract Addresses",
Expand Down
1 change: 1 addition & 0 deletions pages/price-feeds/pro/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"type": "separator"
},
"price-feed-ids": "Price Feed IDs",
"payload-reference": "Payload Reference",

"websocket-api-reference": {
"title": "Websocket API Reference ↗",
Expand Down
Loading