diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..7cc43d9 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,16 @@ +repos: + - repo: local + hooks: + - id: mkdocs-build + name: mkdocs build --strict + entry: .venv/bin/mkdocs build --strict + language: system + pass_filenames: false + files: ^(docs/|mkdocs\.yml) + + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.43.0 + hooks: + - id: markdownlint + args: ["--fix"] + exclude: ^\.claude/ diff --git a/docs/quickstart.md b/docs/quickstart.md index bbbdde7..a50a3fa 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -107,4 +107,4 @@ Read these to understand the format. Create your own based on your project. ## Links - **Working Demo**: [demo-fastapi](https://github.com/ambient-code/demo-fastapi) -- **Presentation**: [PRESENTATION-ambient-code-reference.md](../PRESENTATION-ambient-code-reference.md) +- **Presentation**: [PRESENTATION-ambient-code-reference.md](https://github.com/ambient-code/reference/blob/main/PRESENTATION-ambient-code-reference.md) diff --git a/mkdocs.yml b/mkdocs.yml index ac3b587..ca15c7e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,7 +73,9 @@ nav: - Foundation: - Security Patterns: patterns/security-patterns.md - Testing Patterns: patterns/testing-patterns.md - - ADR Template: adr/template.md + - ADR: + - About ADRs: adr/README.md + - Template: adr/template.md extra: social: diff --git a/requirements-dev.txt b/requirements-dev.txt index 887e0c7..0582419 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -2,3 +2,8 @@ black>=23.12.0 isort>=5.13.0 ruff>=0.1.0 +pre-commit>=3.6.0 +mkdocs>=1.6.0 +mkdocs-material>=9.5.0 +mkdocs-mermaid2-plugin>=1.1.0 +pymdown-extensions>=10.0.0