Skip to content

Bring the site repository to the workspace documentation standard #1

Description

@grammaton

This repository is now the destination of three publishing pipelines — faust-libraries, sean and seam-ltm all write into it — but it is the only one of the four that does not follow the workspace standard.

It has a README.md (rewritten on 2026-08-28, describing the collections, the URL rule and which files are generated). It has no CLAUDE.md, no TODO.md and no logs/.

Why it matters here more than elsewhere

The conventions that govern this repo are the kind that leave no trace when broken:

  • files under _libraries/, _sean/ and _ltm/ are generated, and editing one here is silently undone at the next publish;
  • _data/navigation.yml has blocks between # BEGIN <name> / # END <name> markers owned by the source repos — outside the markers you write by hand, inside you do not;
  • GitHub Pages must stay off on the three project repositories: when a project page and this user site claim the same path, the project page wins, and this site's pages would be built, uploaded and never served with no error anywhere.

The README states all three. A CLAUDE.md would put them where an agent working in this repo reads them first.

What to do

  • CLAUDE.md — the shared Convenzioni comuni block, then the site-specific rules above.
  • TODO.md — open work as a checklist.
  • logs/ — one dated YYYY-MM-DD-processo.md per intervention.

Reference shape: the-accountant/logs/ and the CLAUDE.md of any repo in the gs workspace.

Also worth deciding here

The site is served from master while sean and seam-ltm use main. Not a problem, but worth being deliberate about rather than inherited.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions