feature: Reorganize notes, and add section descriptions

This commit is contained in:
Keith Solomon
2026-01-25 12:23:41 -06:00
parent 5465665c26
commit 2992c17fd7
8 changed files with 85 additions and 26 deletions

View File

@@ -0,0 +1,27 @@
---
title: Developer Onboarding
section: dev-notes
summary: Quick start steps to clone, install dependencies, and generate the site locally
tags: [onboarding, setup]
nav: 1
---
## Getting started
1. Clone the repository and install Node 20+.
2. Run `npm install` to pull dependencies.
3. Build with `npm run build`; output lands in `dist/`.
4. Serve `dist/` via any static server (e.g., `npx serve dist`).
## Directory overview
- `content/`: Markdown notes with front matter.
- `templates/`: HTML shells for header, footer, and layout.
- `assets/`: CSS and JavaScript shared across pages.
## Conventions
- Use kebab-case filenames.
- For organization, use sections defined in `sections.json` and include section in filename.
- Keep summaries short; they populate listings and the search index.
- Add tags to improve search results.