Skip to content

Split into per language readme #17

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.

Sign up for GitHub

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

Merged
johnpmitsch merged 2 commits into from
Apr 27, 2026
Merged

Split into per language readme #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1e8eea
Refactor docs
johnpmitsch Apr 27, 2026
bf29267
Add TOC
johnpmitsch Apr 27, 2026
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
10 changes: 9 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,15 @@ Core clients are tested using mocked API calls with wiremock. All functions maki

### Documentation
- Keep inline documentation comments updated with each change
- Keep README.md updated with each change
- The repo has **five READMEs**, each with a defined scope:
- Root `README.md` — project landing page: structure, install index, development, releasing. **Do not** add per-language API examples here.
- `crates/core/README.md` — Rust-only docs (renders on crates.io)
- `python/README.md` — Python-only docs (renders on PyPI)
- `npm/README.md` — Node.js-only docs (renders on npmjs)
- `ruby/README.md` — Ruby-only docs (renders on RubyGems)
- Any user-facing change to a method, parameter, return type, error class, or environment variable must be reflected in **all four** per-language READMEs in the same PR. This matches the polyglot consistency rule for `__init__.py`, `sdk.d.ts`, and `quicknode_sdk.rbs` documented in §SDK-Specific Guidelines → Polyglot consistency.
- The Configuration env-var table and the Error Handling class table are duplicated verbatim across all four per-language READMEs. When one changes, update all four — keep them byte-identical.
- Per-language READMEs are wired into package metadata (`crates/core/Cargo.toml` `readme`, `pyproject.toml` `readme`, `npm/package.json` `files`, `ruby/quicknode_sdk.gemspec` `s.files`). When adding a new language or moving a README, update the corresponding manifest.

## Code style

Expand Down
Loading
Loading