Notes

Purpose

This repository is a Markdown-based archive of reusable technical knowledge, intended for publication on public GitHub. It is designed for long-term reading, CLI search, reviewable Git history, and use as an Obsidian vault.

Repository Layout

.github/    GitHub Actions workflows
archive/    reviewed long-term technical notes
assets/     public attachments referenced by notes
docs/       repository policies and maintenance documentation
scripts/    local and CI repository checks
templates/  reusable note templates
tmp/        public drafts awaiting review
LICENSE     CC BY 4.0 legal text for repository content
LICENSE-CODE  MIT license text for automation and configuration

GitHub, Git, Node.js, Markdown lint, and license metadata stay at the repository root so their standard commands and discovery behavior remain predictable. Local tool state and generated dependencies may also appear at the root, but must remain ignored rather than becoming part of the public layout.

Every tracked path is part of the public repository. tmp/ means unreviewed, not private.

Note Lifecycle

new note
→ tmp/
→ content, privacy, and duplicate review
→ archive/ or remain in tmp/

Personal records, credentials, private infrastructure details, and content with uncertain publication rights stay outside this repository.

Authoring

Knowledge notes use YAML frontmatter, one H1 title, and an early summary. Start from the note template and follow the document format policy.

Use standard relative Markdown links so links work on GitHub, in CLI tooling, and in Obsidian without a repository-wide conversion.

Quality Checks

Install the locked Markdown tooling and run the same checks used by GitHub Actions:

npm ci --ignore-scripts --no-audit
scripts/install_gitleaks.sh
npm test

The checks validate migrated note metadata, Markdown structure, local links, the legacy-format migration boundary, the complete reachable Git history, and common public-release risks. The pinned Gitleaks binary is installed under the ignored .tools/ directory. See CI and local checks for scope and limitations.

Preview bounded, read-only batches from the remaining legacy-format queue with:

npm run plan:migration -- --prefix archive/python

Obsidian

Open the repository root as an existing Obsidian vault. Keep .obsidian/ local and untracked; Git remains the canonical history for public content.

Configure new notes to land in tmp/, use relative Markdown links instead of Wikilinks, enable automatic link updates, set attachments to assets/, and point the core Templates plugin at templates/. See Obsidian vault usage for the authoring, attachment, and search workflow.

Licensing

Unless a file or an embedded source notice says otherwise:

• Content and documentation under archive/, tmp/, docs/, templates/, and author-created assets/, together with README.md and AGENTS.md, are licensed under CC BY 4.0.
• Automation and repository configuration under scripts/ and .github/, together with package.json, package-lock.json, .gitignore, .node-version, and .markdownlint-cli2.jsonc, are licensed under the MIT License.

Only rights held by repository contributors are licensed. Third-party names, trademarks, quoted material, linked content, and material carrying another license remain subject to their respective rights and notices.

Recommended content attribution is: Notes repository contributors, CC BY 4.0, with a link to the source material and an indication of changes.

Repository Policies

• Document numbering
• Markdown generation
• GitHub uploads and updates
• Draft review
• Publication and redaction
• Document format
• CI and local checks
• GitHub repository settings
• Obsidian vault usage

Agent behavior and structural safeguards are defined in AGENTS.md.