Skip to content
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.

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

Document structure #93

Open
martinthomson opened this issue Feb 20, 2025 · 1 comment
Open

Document structure #93

martinthomson opened this issue Feb 20, 2025 · 1 comment

Comments

@martinthomson
Copy link
Member

Discussed with editors and we tentatively agreed about a plan for document structure.

Right now we have have a section on API that includes both usage and implementation internals. We agreed to split those into two sections so that we can present usage up front. The API internals section can include data structures and algorithms, plus maybe permissions policy integration and other detailed stuff that users likely don't care about much. (We'll need to review this again, likely, but this should give us a place to start.)

@csharrison
Copy link
Collaborator

I'd argue that permissions policy should go into the "usage" section as it is caller-facing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants