docs: Update docs and add adding new policy guide #187
Conversation
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
Mielek
changed the title
tomkerkhove
approved these changes
Nov 28, 2025
Member
tomkerkhove
left a comment
tomkerkhove
left a comment
There was a problem hiding this comment.
Added a bunch of comments to make it more fluent/structurize but LGTM; I'll give this a try soon!
| Refer to existing policies for detailed examples. It is recommended to look at `RateLimit` or `Quota` policies. | ||
| They are contain all possible aspects of a policy compilation implementation. | ||
|
|
||
| ## Steps to add a new policy |
Member
There was a problem hiding this comment.
I'd break this apart in to the same steps defined in section above; this also allows you to provide deep links to people when needed
Collaborator
Author
There was a problem hiding this comment.
I do not understand your point. but let's for now keep it that way. We iterate on that guide after it will be tried by contributor.
Member
There was a problem hiding this comment.
I would add sub headers similar to what you have in the list above
### Compiler
guidance
### Tests
guidance
But sounds good =)
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #178, #183
Enables contributors #179