The document hub for the NJ Office of Innovation engineering team. Guides, references, and shared knowledge for building and maintaining our projects.
Deployed at: https://newjersey.github.io/innovation-engineering/
- Architecture
- Installation
- Usage
- Linting and formatting
- Claude Code skills
- Contributing
- License
- Contact
- Disclaimer
This site is built as a static documentation site using Astro and the Starlight theme, deployed via GitHub Pages.
- Astro - Static site framework
- Starlight - Documentation theme for Astro
- Biome - Code formatter and linter for JS/TS/CSS
- markdownlint - Markdown linter
- Husky + lint-staged - Pre-commit hooks
# Clone this repository
git clone https://github.com/newjersey/innovation-engineering
# Go into the repository
cd innovation-engineering
# Install dependencies
pnpm installAll commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm run dev |
Starts local dev server at localhost:4321 |
pnpm start |
Starts local dev server at localhost:4321 |
pnpm run build |
Build your production site to ./dist/ |
pnpm run preview |
Preview your build locally, before deploying |
pnpm run format |
Format source files with Biome |
pnpm run lint:md |
Lint all markdown files with markdownlint |
pnpm astro ... |
Run CLI commands like astro add, astro check |
pnpm astro -- --help |
Get help using the Astro CLI |
Code (JS/TS/CSS/Astro) is formatted by Biome. Run pnpm run format to
format all source files.
Markdown is linted by markdownlint. Run
pnpm run lint:md to check all content files. The configuration in .markdownlint.jsonc is
tailored for Starlight (no h1 in body, MDX component support, admonition compatibility).
Husky runs lint-staged on every commit:
- Biome checks staged
.ts,.mjs,.astro,.cssfiles - markdownlint checks staged
.mdand.mdxfiles
If you need to skip hooks for a specific commit (e.g., a work-in-progress), use git commit --no-verify.
This project includes Claude Code skills for
common wiki authoring tasks. Run them from Claude Code with the / prefix.
| Skill | Description |
|---|---|
/new-doc |
Scaffold a new wiki document. Recommends the correct Diataxis doc type (guide vs. reference), proposes a filename and location, and generates a structured starting point with cross-links. |
/review-doc |
Review a document for Diataxis alignment, style guide adherence, cross-linking opportunities, and sensitive content. Reports findings by severity. |
/expand-stub |
Flesh out a WIP stub into a more complete page. Proposes an outline appropriate for the doc type and generates draft content or a skeleton with guiding questions. |
/cross-link |
Find missing cross-link opportunities between a document and the rest of the wiki. Suggests specific links with correct paths and placement. |
All engineers are encouraged to contribute and make improvements to existing documentation as they see fit.
See the adding docs page for all info!
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a pull request
This project is licensed under the MIT license. For more information, see LICENSE.
If you want to get in touch with the Office of Innovation team, please email us at team@innovation.nj.gov.
If you are excited to design and deliver modern policies and services to improve the lives of all New Jerseyans, you should join the New Jersey State Office of Innovation!
This project utilizes certain tools and technologies for development purposes. The inclusion of these tools does not imply endorsement or recommendation. Users are encouraged to evaluate the suitability of these tools for their own use.