Skip to content

Nix Documentation Fixes#2052

Closed
picnoir wants to merge 4 commits intosupabase:developfrom
picnoir:nix/fix-mkdocs
Closed

Nix Documentation Fixes#2052
picnoir wants to merge 4 commits intosupabase:developfrom
picnoir:nix/fix-mkdocs

Conversation

@picnoir
Copy link
Collaborator

@picnoir picnoir commented Feb 17, 2026

What kind of change does this PR introduce?

  • Introduces a serve-nix-doc command to the devshell to interactively work on the mkdocs documentation site.
  • Link orphan pages.
  • Fix various markdown format issues.
  • Remove dead links.

Adding the documentation virtual env to the devshell packages creates
a conflict on pygmentize with the existing python viruatlenv.

       > pkgs.buildEnv error: two given paths contain a conflicting subpath:
       >   `/nix/store/kvryivzraaa1cw1j3r9zslng9n8nf8lw-python3-3.13.11-env/bin/pygmentize' and
       >   `/nix/store/yag41lb6wzdj5vh0ikjf072ycf546cc2-python3-3.13.11-env/bin/pygmentize'
       > hint: this may be caused by two different versions of the same package in buildEnv's `paths` parameter
       > hint: `pkgs.nix-diff` can be used to compare derivations

Instead of authorizing the conflicts in this devshell buildEnv, we
prefer hiding the doc devenv in a separate command to make sure
nothing unexpectally breaks on a nixpkgs update in the future.
The list rendering was broken in a few places. Adding some minor
visual tweaks as well.
mkdocs do not support linking to source files living outside of the
doc repository. Replacing these dead links with quoted paths.
@picnoir picnoir requested review from a team as code owners February 17, 2026 10:52
@picnoir
Copy link
Collaborator Author

picnoir commented Feb 17, 2026

Erf, the CI is failing running from my fork. It do not have access to the secrets.

I can re-open this from a branch on this repo, but I'd need write access to do this.

@picnoir picnoir mentioned this pull request Feb 17, 2026
@picnoir
Copy link
Collaborator Author

picnoir commented Feb 17, 2026

Cont. #2053

@picnoir picnoir closed this Feb 17, 2026
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

Successfully merging this pull request may close these issues.

1 participant