docs: add EN/PL documentation catalog - #5
Merged
Merged
Conversation
Adds a docs/ directory with long-form documentation for the base image, the published features and setup.sh, in English and Polish. Versioned alongside the Dockerfile, setup.sh and src/ it describes, and rendered at zanreal.com/docs. Content verified against the repository: feature list and versions, the DEVCONTAINER_TOOLS identifiers, wizard marker files, the Tinybird uv bootstrap and the traefik:v3.7 image tag. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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.
Adds a
docs/directory holding the long-form documentation for the base image, in English and Polish. There is nodocs/in the repo today; this is additive only. NoDockerfile,setup.sh,wizard.sh,src/, README or CI files are touched.What the directory is
README.mdstays the landing page.docs/is where behaviour is documented in full: the setup sequence step by step, every feature option, and the failure modes that only turn up in real use. Keeping it in this repo means it versions with theDockerfile,setup.shandsrc/it describes.The same directory is the source for the rendered docs at zanreal.com/docs - the site pulls these files, so there is no second copy to keep in sync.
docs/README.mdexplains that arrangement for anyone who opens the directory cold.Contents
Three pages per locale:
index.{en,pl}.mdxfeatures.{en,pl}.mdxconfiguration.{en,pl}.mdxBoth locales are written natively rather than translated, so they differ by design - the English configuration page walks the setup sequence as numbered steps, while the Polish one opens with a nine-point overview and then breaks out only the four steps that have traps in them.
Verified against the repository
This content had not been reviewed before, so the factual claims were checked against the source rather than taken on trust:
bun1.0.0 throughtraefik1.3.2,uv1.0.1) against eachsrc/*/devcontainer-feature.jsonDEVCONTAINER_TOOLSidentifiers against the case arms inwizard.sh~/.devcontainer-selections,~/.devcontainer-wizard-doneand/tmp/devcontainer-wizard.loguvself-bootstrap whenuvis absenttraefik:v3.7image tag insrc/traefik/install.shAll matched. No corrections to the README were needed.
Fixed while preparing this
configuration.pl.mdxandfeatures.pl.mdxhad unquoteddescriptionvalues containing a colon, which YAML reads as a nested mapping and rejects withYAMLParseError: Nested mappings are not allowed in compact mappings. Both are now quoted; all six pages parse.Odwołanie, a word-for-word rendering of "Reference" that means a citation or an appeal in Polish, not an identifier. Changed toIdentyfikator. Also softenedpowtarzalne budowania co do bajtatobuildy powtarzalne co do bajta, which is how the phrase is actually said.Formatting choices
The content was authored for our fumadocs site and has been adapted for a repo where GitHub is at least as likely a reader as the docs site:
./features.en.mdx), so they resolve in both places. The link toexamples/devcontainer.jsonstays an absolute GitHub URL, since a relative path out ofdocs/would break on the docs site.<Callout>and<Callout type="warn">became> [!NOTE]and> [!WARNING], which GitHub renders natively as styled callouts and which fumadocs also understands - this is the one case where the portable form is as good as the original.<Cards>became a Markdown list,<Steps>/<Step>became numbered headings, and the// [!code highlight]annotations were dropped. All of these would otherwise show up as literal text on GitHub.```jsonc title="..."blocks were kept as-is. GitHub ignores the meta string and still highlights the block, while the docs site uses it to label the file - so there is nothing to gain by removing it.meta.json/meta.pl.jsonare kept. They carry page order and section title for the docs site, are inert on GitHub, and nothing else in the repo depends on them.CONTRIBUTING.mdcovers local image builds, feature testing and the tag-driven release flow; none of it applies to a docs-only change, and nothing here conflicts with it.🤖 Generated with Claude Code