Skip to content

Commit b1dd773

Browse files
committed
Tweaks
1 parent c213d07 commit b1dd773

9 files changed

Lines changed: 21 additions & 4 deletions

File tree

docs/ai-ide-support.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
The AI-Native Python template includes configuration files to work seamlessly with AI-powered development tools.
44

5+
[← Back to Documentation Index](index.md)
6+
7+
58
## Tool-agnostic configurations
69

710
### .mcp.json

docs/ci-cd.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
The AI-Native Python template includes GitHub Actions workflows for automated testing, security scanning, and release management.
44

5+
[← Back to Documentation Index](index.md)
6+
57
## Included Workflows
68

79
### CI Pipeline (`.github/workflows/ci.yml`)

docs/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This guide covers the configuration options available in the AI-Native Python cookiecutter template.
44

5+
[← Back to Documentation Index](index.md)
6+
57
## Cookiecutter Variables
68

79
When generating a new project, you'll be prompted for the following configuration options:

docs/faq.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Frequently Asked Questions
22

3+
[← Back to Documentation Index](index.md)
4+
35
## Version Control System support
46

57
### Q: Do you support version control platforms other than GitHub?

docs/hooks.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
The AI-Native Python template uses hooks to automate setup tasks automatically.
44

5+
[← Back to Documentation Index](index.md)
6+
57
## Cookiecutter Hooks
68

79
### Post-Generation Hook

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Welcome to the AI-Native Python documentation. This guide will help you understa
99
- [Optional Setup](optional-setup.md) - Additional tools and configurations
1010

1111
### Development Workflow
12-
- [AI IDE Support](ai-ide-support.md) - Claude, Copilot, and Cursor configurations
12+
- [AI IDE Support](ai-ide-support.md) - such as configuring Claude, Copilot, Cursor, or other IDEs
1313
- [Testing](testing.md) - Test structure, running tests, and coverage
1414
- [Hooks](hooks.md) - Cookiecutter and pre-commit hooks
1515

docs/optional-setup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This guide covers optional setup steps and configurations for the AI-Native Python template.
44

5+
[← Back to Documentation Index](index.md)
6+
57
## Grant Installation (License Compliance)
68

79
If you'd like to support license file checking locally, you will need to install `grant` and put it in your `PATH`. See [their installation

docs/roadmap.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This document outlines future improvements and enhancements for the ai-native-python project.
44

5+
[← Back to Documentation Index](index.md)
6+
57
## Ideas
68

79
### 1. Add Policy as Code

docs/testing.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ This document covers two distinct testing contexts:
55
1. **Template Tests** - Tests for the AI-Native Python cookiecutter template itself (i.e. this repository)
66
2. **Generated Project Tests** - Tests included in projects created from this template (i.e. projects rendered after running `cookiecutter`)
77

8+
[← Back to Documentation Index](index.md)
9+
810
## Template Tests
911

1012
These tests ensure the cookiecutter template works correctly and generates valid projects.
@@ -42,9 +44,9 @@ Every project created from this template includes a complete testing setup.
4244

4345
```bash
4446
# From the generated project root
45-
task test # Run all tests with coverage
46-
pytest tests/unit -v # Run unit tests only
47-
pytest tests/integration -v # Run integration tests only
47+
task test # Run all tests with coverage
48+
task unit-test # Run unit tests only
49+
task integration-test # Run integration tests only
4850
```
4951

5052
### Writing Tests in Generated Projects

0 commit comments

Comments
 (0)