feat: refactor documentation AR-8#446
Open
Minister944 wants to merge 4 commits into
Open
Conversation
Split the flat docs/ files into guides/reference/plugins/community sections with proper sidebar categories, add missing guide pages (schema sources, subscriptions, file uploads, custom scalars, extending types, multiple clients, OpenTelemetry, async vs sync, schema generation), and slim README.md down to a feature overview that links out to the new docs site instead of duplicating content.
…gration Relative links inside docs/ still pointed at the old docs/... paths, em dashes rendered inconsistently, and a few pages were missing recently added settings (remote_schema_http_client_path, introspection_*, opentelemetry-api dependency).
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Minister944
commented
Jul 13, 2026
Contributor
Author
There was a problem hiding this comment.
I wasn't able to set this int reference for the readme, so here's a copy-paste
Minister944
commented
Jul 13, 2026
Contributor
Author
There was a problem hiding this comment.
Do we need this file?
Collaborator
There was a problem hiding this comment.
leave it for now
Kwaidan00
reviewed
Jul 14, 2026
Co-authored-by: Aleksander Spyra <aleksander.spyra@mirumee.com>
- schema-sources: document directory extension behavior; reframe schema_paths around combining multiple files (installed packages as secondary use case) - using-generated-client: add basic init example, drop redundant headers heading, move context-manager section before configuration, split advanced HTTP config into httpx vs custom-client sections, fix non-httpx client claims - subscriptions: drop redundant client-configuration link - extending-types: clarify files_to_include is required for relative mixin imports - opentelemetry: link opentelemetry-api to PyPI - async-vs-sync: drop duplicated setting bullet and sections repeating the client guide - schema-generation: bulletize schema-source options, link process_schema hook - custom-operation-builder: fold Enabling into intro, rename example sections - configuration: restore original remote_schema_http_client_path description - README: link Contributing directly to CONTRIBUTING.md
Kwaidan00
approved these changes
Jul 15, 2026
DamianCzajkowski
approved these changes
Jul 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructures the docs from a flat, README-derived layout into a categorized Docusaurus site, and slims README.md into a landing page. Content was split out of the README, then expanded and corrected against the source code - several settings and behaviours were missing or stale.
New docs/ structure: