Codrlabs Open

Documentation site for the open-source projects Codrlabs builds and mentors in the open. Ships to open.codrlabs.com.

Built with Astro + Starlight.

Run it

npm install
npm run dev      # http://localhost:4321
npm run build    # static build into dist/ (astro build)
npm run preview  # serve the built site locally

Deploy

Push to main. GitHub Actions builds the site and publishes it to GitHub Pages at open.codrlabs.com — there is no manual deploy step. Commits that only touch TODO.md, README.md or LICENSE skip the deploy.

Layout

src/content/docs/
  index.mdx            landing page
  start/               what this initiative is, how to contribute
  vizably/             Vizably docs
astro.config.mjs       site URL, title, sidebar

Add a project by creating src/content/docs/<project>/ and giving it a section in the sidebar array in astro.config.mjs. Pages are Markdown or MDX; frontmatter needs at least a title.

Status

See TODO.md for what is done, what is open, and the exact next command for each open item.