feat(docs): Add an Update guide and start security advisories directory by SirBerg · Pull Request #55 · iglu-sh/iglu

SirBerg · 2026-10-16T20:17:15Z

Don't worry I started the v0.0.3 docs as well (that's why it's +12.929).
The interesting paths (beyond the new v0.0.3 docs) are:

docs/docs/02-cache/03-versions
docs/docs/02-cache/04-security

cloudflare-workers-and-pages · 2026-10-17T07:17:39Z

Deploying iglu with Cloudflare Pages

Latest commit:	`2b2bc2a`
Status:	✅ Deploy successful!
Preview URL:	https://8424451b.iglu.pages.dev
Branch Preview URL:	https://feat-update-guide.iglu.pages.dev

View logs

Svenum

I don't know how, but if you select v0.0.3 in the drop down the docs sidebar looks like this:

with the docs dir on the top.

Additionally, I think you misunderstood me about the version page, as we were speaking about it.
I meant a page for developer where is described how to create a new version. E.g.:

update version in package.json
update version in pyproject.toml
...

Don't get me wrong your understanding of that topic is also important. 👍

Do you want to add the page I meant in v0.0.3 or later on?

Svenum · 2026-10-17T11:01:33Z

Another thing, I just missed. Change the order of releases under Versions & Update Guide so that the newest is on top.

SirBerg · 2026-10-17T11:05:42Z

Another thing, I just missed. Change the order of releases under Versions & Update Guide so that the newest is on top.

We can do that however everytime we update a version we'll have to change the numbering for every other release page so except if you have another idea how to order them I think we should leave it like that for now

SirBerg · 2026-10-17T11:10:30Z

I don't know how, but if you select v0.0.3 in the drop down the docs sidebar looks like this:
with the docs dir on the top.

Additionally, I think you misunderstood me about the version page, as we were speaking about it. I meant a page for developer where is described how to create a new version. E.g.:
* update version in package.json

* update version in pyproject.toml

* ...
Don't get me wrong your understanding of that topic is also important. 👍

Do you want to add the page I meant in v0.0.3 or later on?

I can also add that as well in this PR 👍

Svenum · 2026-10-17T11:19:20Z

Another thing, I just missed. Change the order of releases under Versions & Update Guide so that the newest is on top.

We can do that however everytime we update a version we'll have to change the numbering for every other release page so except if you have another idea how to order them I think we should leave it like that for now

You can actually add sidebar_position with negative numbers in the metadata of a page (where title and slug already is). So we can just count negative numbers.

v0.0.2: sidebar_position: 0
v0.0.3: sidebar_position: -1
v0.0.4: sidebar_position: -2
...

SirBerg · 2026-10-17T11:20:53Z

Another thing, I just missed. Change the order of releases under Versions & Update Guide so that the newest is on top.

We can do that however everytime we update a version we'll have to change the numbering for every other release page so except if you have another idea how to order them I think we should leave it like that for now

You can actually add sidebar_position with negative numbers in the metadata of a page (where title and slug is already). So we can just count negative numbers.
* v0.0.2: `sidebar_position: 0`

* v0.0.3: `sidebar_position: -1`

* v0.0.4: `sidebar_position: -2`

* ...

I expected nothing less insane from Facebook lol. Alright I'll rewrite it

SirBerg · 2026-10-17T16:51:00Z

Should be ready for review now

Svenum · 2026-10-17T18:21:07Z

+After all of these versions are updated, go through these steps **one after another**
+1. A Github Release needs to be drafted as well, however this must **only be done after the versions are updated in the files above** so that the workflows aren't affected.
+2. Once the Github Release has been drafted and published, create a new release note in `docs/docs/04-versions` with the version's number as the title, put the Github Release Markdown into this document and add some Meta information (like a Link to the Github Release).
+3. Add the Release to the releases table in `docs/docs/04-versions/index.mdx`
+4. If this release is for a a Minor or Major version or entails some big docs changes in any way (even on a patch), a new versioned doc has to be created. Follow these steps:
+    1. Enter the new Doc version in the `docs/docusaurus.config.ts` file under the `preset.classic.docs.versions` path with the version number as the key, label, path and `banner:"none"`
+    2. Create a new directory at `docs/versioned_docs/version-${your_version_number}`
+    3. Copy all the files from `docs/docs` into your new directory
+5. Add the Github Release URL to the table later down this document 


I think the docs have to be created before the release on GitHub

They don't, as they include the github release. Kind of the "chicken and the egg" problem

The way I think of it is: The actual release is the one we do on Github. It exists independent on what is shown in the Docs and may or may not actually include the changed docs.

No, I disagree. Everything including the docs have to be ready before the release. There should be a PR "update tp x.y.z" and directly after that a new release should be created.

Well in that case we need to re-think our release strategy because this is how it has worked for the v0.0.2 release. The Github Release was the actual release and afterwards everything was entered in the docs and released in a seperate PR (see #52) I'm down to do this but that means we'll be collecting and writing manual changelogs instead of the Github ones. We could also drop the requirement that we have the changelogs in the docs if that's not something you're willing to do.
I'm still in favor of seeing docs and reality as two seperate things (as it is so often the case anyway) but if you want we can discuss this in a discord call instead of github comments.

Co-authored-by: Sven Ziegler <43136984+Svenum@users.noreply.github.com>

Svenum · 2026-10-18T16:20:14Z

As #56 is merged you can change this part already in the release guide

SirBerg requested a review from Svenum October 16, 2026 20:17

feat(docs): Add an Update guide and start security advisories directory

b292b75

SirBerg force-pushed the feat-update-guide branch from 5dcd3be to b292b75 Compare October 17, 2026 07:17

Svenum requested changes Oct 17, 2026

View reviewed changes

Comment thread docs/docs/04-versions/index.mdx Outdated

chore(docs): Fix docs folder in v0.0.3 docs

2ec9f81

SirBerg requested a review from Svenum October 17, 2026 16:50

feat(docs): Add an Update guide for devs

9ddede6

SirBerg force-pushed the feat-update-guide branch from 575ff93 to 9ddede6 Compare October 17, 2026 16:59

Svenum requested changes Oct 17, 2026

View reviewed changes

Update builder/pyproject.toml

2b2bc2a

Co-authored-by: Sven Ziegler <43136984+Svenum@users.noreply.github.com>

Conversation

SirBerg commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cloudflare-workers-and-pages Bot commented Oct 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying iglu with Cloudflare Pages

Uh oh!

Svenum left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Svenum commented Oct 17, 2026

Uh oh!

SirBerg commented Oct 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SirBerg commented Oct 17, 2026

Uh oh!

Svenum commented Oct 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SirBerg commented Oct 17, 2026

Uh oh!

SirBerg commented Oct 17, 2026

Uh oh!

Uh oh!

Svenum Oct 17, 2026

Choose a reason for hiding this comment

Uh oh!

SirBerg Oct 17, 2026

Choose a reason for hiding this comment

Uh oh!

SirBerg Oct 17, 2026

Choose a reason for hiding this comment

Uh oh!

Svenum Oct 17, 2026

Choose a reason for hiding this comment

Uh oh!

SirBerg Oct 17, 2026

Choose a reason for hiding this comment

Uh oh!

Svenum commented Oct 18, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SirBerg commented Oct 16, 2026 •

edited

Loading

cloudflare-workers-and-pages Bot commented Oct 17, 2026 •

edited

Loading

SirBerg commented Oct 17, 2026 •

edited

Loading

Svenum commented Oct 17, 2026 •

edited

Loading