A map of the repository: a README in every folder, a synopsis in every file
- github
- github/openchronology/timeline-app
- commit
- main
- github/athanclark
#176. Every folder has a README.md: what it is for, and a table of what each of its files and subfolders is for (85 of them). CONTRIBUTING.md is the top level's, with how to find your way and make a change. Every code file begins, after its copyright line, with a synopsis of what it is for; about 240 gained one, comments only. test/contents.test.mjs keeps it so: a folder without a README, a README that leaves out a file, lists one that is gone or links nowhere, or a code file without a synopsis fails npm test. Along the way: the help area leaves docs/README.md to the repository; the server packages install the project's README rather than docs/README.md over it; a few copyright lines move back to the top of their files; and a packaging comment names the script that exists. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_011fFY8eruEi1xAkkMBni13B https://github.com/openchronology/timeline-app/commit/0e8d25da2afb966b80826eb8410e9150a0d093ac
Related
Open A map of the repository: a README in every folder, a synopsis in every file in the timeline