unitoo/website
1
0
Fork 1
Code Issues 1 Pull requests Packages 1 Activity

docs: consolidate developer docs and remove devcontainer #59

Merged
claudiomaradonna merged 2 commits from docs/consolidate-developer-docs into master 2026-05-27 09:44:22 +02:00
Conversation 0 Commits 2 Files changed 6 +228 -200
claudiomaradonna commented 2026-05-27 09:44:06 +02:00
Collaborator
Copy link

Developer documentation was scattered and inconsistently maintained: CLAUDE.md was long and duplicated detail, README.md was
too terse to onboard someone new, and there was no dedicated place for technical internals. The devcontainer (podman-based, using
a locally generated base image) was also sitting in the repo untouched and liable to confuse anyone comparing it with the
production Docker build.

This PR restructures the situation: README.md is expanded into a proper quick-start, commands, layout, and editing guide;
docs/architecture.md is introduced as the stable technical reference covering i18n, the asset pipeline, SEO internals, and
deploy; CLAUDE.md is trimmed to a concise rules-and-gotchas file that cross-references the other two, keeping the AI context
window lean. The devcontainer files are deleted and Dockerfile.claude-jail is added to .gitignore to prevent accidental
commits of locally generated variants.

Developer documentation was scattered and inconsistently maintained: `CLAUDE.md` was long and duplicated detail, `README.md` was too terse to onboard someone new, and there was no dedicated place for technical internals. The devcontainer (podman-based, using a locally generated base image) was also sitting in the repo untouched and liable to confuse anyone comparing it with the production Docker build. This PR restructures the situation: `README.md` is expanded into a proper quick-start, commands, layout, and editing guide; `docs/architecture.md` is introduced as the stable technical reference covering i18n, the asset pipeline, SEO internals, and deploy; `CLAUDE.md` is trimmed to a concise rules-and-gotchas file that cross-references the other two, keeping the AI context window lean. The devcontainer files are deleted and `Dockerfile.claude-jail` is added to `.gitignore` to prevent accidental commits of locally generated variants.
The devcontainer (podman-based, extending claude-jail) is no longer
maintained alongside the website source. Deleting the Dockerfile and
its README avoids confusion with the production Docker build and
removes stale setup instructions.

Dockerfile.claude-jail is added to .gitignore to prevent accidentally
committing any locally generated variant of that base image spec.
Developer documentation was split across CLAUDE.md (long, duplicated
detail), README.md (too terse to be useful) and no dedicated architecture
doc at all.

README.md is expanded into a full quick-start + commands + layout +
editing guide. docs/architecture.md is introduced as the stable technical
reference (i18n, asset pipeline, SEO, deploy internals). CLAUDE.md is
trimmed to a concise rules + gotchas file that cross-references the other
two, keeping the AI context window lean without losing information.
claudiomaradonna deleted branch docs/consolidate-developer-docs 2026-05-27 09:44:26 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
unitoo/website!59
No description provided.