-
Notifications
You must be signed in to change notification settings - Fork 645
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
docs: add HeaderConfig to SecurityConfig + new Gudeline Proposals #2950
Conversation
✅ Deploy Preview for tauri-v2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Hmm, i think something like a generic |
Changed it to |
sorry I'm not sure I get it. Do you mean that we will be having more minors with new feats that needs to be noted as |
yes, exactly. for example in the v1 docs we often mention 1.3 for the first version with nsis support or 1.1 for tauri icon but only as part of the guide text, not via a seperate visual element. |
This feature is included for the next minor release. This being 2.1.0. So it does not make sense to publish the documentation before that. So I changed the PR description from
to
If I was meant to add a notice in the documentation itself, then it's a misunderstanding on my part. @FabianLars mentioned "1.1 for tauri icon", which says in form of regular paragraph text:
Would adding |
this would be enough if on the top of the page detached from content, maybe a banner (if it isn't too much visually) |
* fix typos * feat: Add `SinceVersion` Component * display version * formatting * make SinceVersion a link * change the sidebar order * add framework examples * add library prop to SinceVersion * add new Badge to headers * update documentation guidelines about New Features / Version Display
Since there definitely will be the need for other Also I couldn't find any guidelines, on the Badge On the changes to |
To get formatting Workflow to pass, would mean breaking the page and making the code unpleasant to read. I wouldn't want to change the current formatting much, if possible. Could be related to #2284, but I haven't looked into it. |
no problem, just add the pages that prettier would break to the .prettierignore file |
Say this guideline receives approval. How to enforce it? So, have a file (eg. # Removal Dates
List of files and dates, on which the `New` badge should be removed.
| Directive | Description |
| ------------------- | -------------------------------------------------- |
| Order | Insert so, that the next removal is always on top. |
| Date Format | `YYYY.MM.dd` |
- [`http-headers.mdx`](../src/content/docs/security/http-headers.mdx): 2025.05.13
Or is there some CI workflow for notifications or something like a delayed commit. Both of these come with their own set problems and considerations. |
well... for now I think this is enough. It's great. I'll open an issue and let it open while we figure it out. 6 months is ok imo. is this pr ready? |
I got nothing more to add. Green light from me. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, great work on everything!
Co-authored-by: Vitor Ayres <[email protected]>
Co-authored-by: Vitor Ayres <[email protected]>
I fixed some typos.
Also added documentation for merged PR #11485. Effective since 2.1.0
Edits:
Title
Updated title from
add HeaderConfig to SecurityConfig
todocs: add HeaderConfig to SecurityConfig + new Gudeline Proposals
Guideline Proposals
New Features / Version Display
Add guideline for displaying the version, a feature was introduced via new
SinceVersion
componentBadge Lifetimes
The sidebar has the ability to display badges next to an entry.
Add a guideline for how long a badge with the text contents of
New
is allowed to be displayed.