How this research site is published

Basic deployment path

1. Push the repository to GitHub.
2. In Settings → Pages, choose GitHub Actions as the publishing source.
3. Keep the note-generation script and site files in the repository.
4. Let the workflow publish the docs directory as the final site output.

What the workflow does

1. Check out the repository.
2. Run the local note-generation step where needed.
3. Collect the docs directory as a deployable artifact.
4. Publish the resulting artifact to GitHub Pages.

How to publish a new note manually

Do not edit docs/notes.html or docs/notes/*.html by hand unless you are debugging generated output. Those files are regenerated and will be overwritten by the next local build or GitHub Pages deployment.

A longer Chinese maintenance checklist is kept in docs/notes_site_maintenance_zh.md for day-to-day manual updates.

1. Write or update the Markdown file in Knowledge/.
2. Add a new entry or a new language variant in tools/notes_manifest.json.
3. Run python tools/generate_notes_site.py to rebuild docs/notes.html and docs/notes/*.html.
4. Review the generated pages locally if needed, then commit the Markdown, manifest, and generated docs files.
5. Push to main; GitHub Actions will regenerate and publish the site again.

What to edit when the interface should change

1. Edit tools/notes_manifest.json if you only want to add, remove, rename, reorder, or relabel note cards.
2. Edit tools/generate_notes_site.py if you want the note-page layout or card-button logic itself to change.
3. Edit docs/index.html if you want a note to appear in the homepage featured area.
4. Edit docs/reading-map.html if the reading route or note-entry links should change.
5. Edit docs/assets/site.css if the visual styling of note cards or note pages should change.