Add end-to-end user guide to docs/ - #7
Merged
Merged
Conversation
Ports the internal wiki guide into the repo so documentation is versioned with the code, reviewable through PRs, and present in clones and forks. Install instructions are rewritten for public PyPI (the wiki referenced an internal registry path). The quick-start example, PolicyConfig fields, and entrypoints/builtins/evaluate_raw accessors were run against the real SDK before publishing. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Ports the internal wiki guide into the repo so documentation is versioned with the code, reviewable through PRs, and present in every clone and fork.
Changes
docs/guide.md— new, 563 lines, 7 mermaid diagramsREADME.md— links the guide as the documentation starting pointInstall instructions rewritten
The wiki referenced an internal registry path (
uv add identity-authz.opapywasm.opapywasm) that would not work for public users. Replaced withpip install opa-py-wasm/uv add opa-py-wasm, plus a note thatwasmtimeresolves automatically.Verified before publishing
PolicyConfigfields confirmed to exist with the documented namesentrypoints,builtins, andevaluate_rawchecked against actual outputStructure
The guide is the entry point and links into the existing focused references (
api.md,architecture.md,thread_safety.md,opa_abi.md,capacity_planning.md) rather than duplicating them.