Skip to content

docs: add redirect requirement for ID changes #81

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.

Sign up for GitHub

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

Open
maximiliantech wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −0
Open

docs: add redirect requirement for ID changes #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,28 @@ The resulting URL will be `/operators/setup` (folder path + id).

Pages without an `id:` field will use the filename as-is, including any numeric prefixes — always add one when creating or renaming a page.

### Avoiding breaking URLs

When changing an existing `id:`, you **must** add a redirect in `docusaurus.config.ts` to preserve the old URL:

```ts
plugins: [
[
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
from: '/old/path',
to: '/new/path',
},
],
},
],
],
```

This ensures external links and bookmarks continue to work after ID changes.

## Branch workflow

Work on feature branches based on `main`. Merge via PR.
Expand Down
Loading