From 5d2756543d5d1b31342928e43dbd2fd3cd5aa86f Mon Sep 17 00:00:00 2001 From: Jayant Krishnamurthy Date: Wed, 29 Oct 2025 08:19:19 -0700 Subject: [PATCH 1/5] add to meta.json --- pages/price-feeds/pro/_meta.json | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/price-feeds/pro/_meta.json b/pages/price-feeds/pro/_meta.json index d7330b56..6c8e10f0 100644 --- a/pages/price-feeds/pro/_meta.json +++ b/pages/price-feeds/pro/_meta.json @@ -16,6 +16,7 @@ "title": "Reference Material", "type": "separator" }, + "payload-reference": "Payload Reference", "price-feed-ids": "Price Feed IDs", "websocket-api-reference": { From 7e8581cb0c6a87f310c6be50af37a28f8f6503f1 Mon Sep 17 00:00:00 2001 From: Jayant Krishnamurthy Date: Wed, 29 Oct 2025 08:22:33 -0700 Subject: [PATCH 2/5] fix stuff --- pages/price-feeds/core/_meta.json | 1 + pages/price-feeds/pro/_meta.json | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/price-feeds/core/_meta.json b/pages/price-feeds/core/_meta.json index 8ec00776..1f620bab 100644 --- a/pages/price-feeds/core/_meta.json +++ b/pages/price-feeds/core/_meta.json @@ -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", diff --git a/pages/price-feeds/pro/_meta.json b/pages/price-feeds/pro/_meta.json index 6c8e10f0..03fd6770 100644 --- a/pages/price-feeds/pro/_meta.json +++ b/pages/price-feeds/pro/_meta.json @@ -16,8 +16,8 @@ "title": "Reference Material", "type": "separator" }, - "payload-reference": "Payload Reference", "price-feed-ids": "Price Feed IDs", + "payload-reference": "Payload Reference", "websocket-api-reference": { "title": "Websocket API Reference ↗", From 14f10dcee3e5fc02d3174e427099afecef0648bd Mon Sep 17 00:00:00 2001 From: Jayant Krishnamurthy Date: Wed, 29 Oct 2025 08:26:41 -0700 Subject: [PATCH 3/5] add to meta.json --- pages/home/oracle-integrity-staking/_meta.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/home/oracle-integrity-staking/_meta.json b/pages/home/oracle-integrity-staking/_meta.json index ce06da22..4e3200aa 100644 --- a/pages/home/oracle-integrity-staking/_meta.json +++ b/pages/home/oracle-integrity-staking/_meta.json @@ -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" } From a08571d662b1297c6acdb4c045a5fe1a7eb2f9c7 Mon Sep 17 00:00:00 2001 From: Jayant Krishnamurthy Date: Wed, 29 Oct 2025 08:27:51 -0700 Subject: [PATCH 4/5] fix readme --- README.md | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/README.md b/README.md index fe5d456c..b4b2de87 100644 --- a/README.md +++ b/README.md @@ -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. @@ -27,21 +22,6 @@ docker run -d -p 3000:3000 documentation Then navigate to localhost:3000 in the browser. -## Tests - -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). From c8ace00ef87687e70908f624831d82599b822836 Mon Sep 17 00:00:00 2001 From: Jayant Krishnamurthy Date: Wed, 29 Oct 2025 08:32:08 -0700 Subject: [PATCH 5/5] make agents.md --- AGENTS.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..49d25802 --- /dev/null +++ b/AGENTS.md @@ -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.