|
1 | 1 | --- |
2 | 2 | type: reference |
| 3 | +name: bootstrap-reference |
3 | 4 | feature: bootstrap |
4 | 5 | depth: reference |
5 | | -generated_at: 2026-04-14T16:08:35.223900+00:00 |
6 | | -source_hash: 747d4d8b3e41bb5a6d7a534fb1402fcfcda15486e7b1994427f88a2f71907ebf |
| 6 | +generated_at: 2026-07-10T13:07:32.401338+00:00 |
| 7 | +source_hash: 40cd7c5eca29231d1a865aa04654239348b46aed8c204904aacc473fc810affe |
7 | 8 | status: generated |
| 9 | +scaffold_hash: 04376ece60b306ed2326639b284d6f17a8ea83d0455ee27fd1c9ca0edf713c11 |
8 | 10 | --- |
9 | 11 |
|
10 | 12 | # Bootstrap reference |
11 | 13 |
|
12 | | -Scan projects and generate feature manifests from discovered code patterns. |
| 14 | +Scan a project directory to propose features and convert accepted proposals into an initial feature manifest. |
| 15 | + |
| 16 | +## Functions |
| 17 | + |
| 18 | +| Function | Parameters | Returns | Description | File | |
| 19 | +|----------|------------|---------|-------------|------| |
| 20 | +| `scan_project` | `project_root: str \| Path` | `list[ProposedFeature]` | Scans a project and proposes features from its directory structure. | `src/attune_author/bootstrap.py` | |
| 21 | +| `proposals_to_manifest` | `proposals: list[ProposedFeature]` | `FeatureManifest` | Converts accepted proposals to a `FeatureManifest`. | `src/attune_author/bootstrap.py` | |
13 | 22 |
|
14 | 23 | ## Classes |
15 | 24 |
|
16 | | -| Class | Description | |
17 | | -|-------|-------------| |
18 | | -| `ProposedFeature` | A feature discovered by scanning | |
| 25 | +| Class | Description | File | |
| 26 | +|-------|-------------|------| |
| 27 | +| `ProposedFeature` | A feature discovered by scanning. | `src/attune_author/bootstrap.py` | |
19 | 28 |
|
20 | 29 | ### ProposedFeature fields |
21 | 30 |
|
22 | | -| Field | Type | Default | Description | |
23 | | -|-------|------|---------|-------------| |
24 | | -| `name` | `str` | | Feature name | |
25 | | -| `description` | `str` | | Human-readable description | |
26 | | -| `files` | `list[str]` | `[]` | Associated file paths | |
27 | | -| `tags` | `list[str]` | `[]` | Classification tags | |
28 | | -| `confidence` | `str` | `'medium'` | Detection confidence level | |
29 | | -| `reason` | `str` | `''` | Why this feature was proposed | |
30 | | - |
31 | | -## Functions |
| 31 | +`ProposedFeature` is a dataclass. |
32 | 32 |
|
33 | | -| Function | Parameters | Returns | Description | |
34 | | -|----------|------------|---------|-------------| |
35 | | -| `scan_project` | `project_root: str \| Path` | `list[ProposedFeature]` | Scan a project and propose features | |
36 | | -| `proposals_to_manifest` | `proposals: list[ProposedFeature]` | `FeatureManifest` | Convert accepted proposals to a FeatureManifest | |
| 33 | +| Field | Type | Default | |
| 34 | +|-------|------|---------| |
| 35 | +| `name` | `str` | — | |
| 36 | +| `description` | `str` | — | |
| 37 | +| `files` | `list[str]` | `field(default_factory=list)` | |
| 38 | +| `tags` | `list[str]` | `field(default_factory=list)` | |
| 39 | +| `confidence` | `str` | `'medium'` | |
| 40 | +| `reason` | `str` | `''` | |
37 | 41 |
|
38 | 42 | ## Constants |
39 | 43 |
|
| 44 | +These module constants control what the scanner skips and recognizes. |
| 45 | + |
40 | 46 | | Constant | Values | Description | |
41 | 47 | |----------|--------|-------------| |
42 | | -| `_SKIP_DIRS` | `'.git'`, `'.github'`, `'.help'`, `'.claude'`, `'.agents'`, `'__pycache__'`, `'.mypy_cache'`, `'.pytest_cache'`, `'.ruff_cache'`, `'.tox'`, `'.venv'`, `'venv'`, `'env'`, `'node_modules'`, `'dist'`, `'build'`, `'.egg-info'`, `'htmlcov'`, `'site'` | Directories to skip during scanning | |
43 | | -| `_ENTRY_POINT_NAMES` | `'main.py'`, `'app.py'`, `'cli.py'`, `'server.py'`, `'manage.py'`, `'wsgi.py'`, `'asgi.py'`, `'index.ts'`, `'index.js'`, `'main.go'`, `'main.rs'` | Common application entry point filenames | |
44 | | -| `_CONFIG_PATTERNS` | `'config'`, `'settings'`, `'conf'` | Filename patterns for configuration files | |
| 48 | +| `_SKIP_DIRS` | `'.git'`, `'.github'`, `'.help'`, `'.claude'`, `'.agents'`, `'__pycache__'`, `'.mypy_cache'`, `'.pytest_cache'`, `'.ruff_cache'`, `'.tox'`, `'.venv'`, `'venv'`, `'env'`, `'node_modules'`, `'dist'`, `'build'`, `'.egg-info'`, `'htmlcov'`, `'site'` | Directories the scan skips. | |
| 49 | +| `_ENTRY_POINT_NAMES` | `'main.py'`, `'app.py'`, `'cli.py'`, `'server.py'`, `'manage.py'`, `'wsgi.py'`, `'asgi.py'`, `'index.ts'`, `'index.js'`, `'main.go'`, `'main.rs'` | Filenames recognized as project entry points. | |
| 50 | +| `_CONFIG_PATTERNS` | `'config'`, `'settings'`, `'conf'` | Name patterns recognized as configuration files. | |
| 51 | + |
| 52 | +## Source files |
| 53 | + |
| 54 | +- `src/attune_author/bootstrap.py` |
| 55 | + |
| 56 | +## Tags |
| 57 | + |
| 58 | +`setup`, `scanning`, `manifest` |
| 59 | +## Faithfulness review |
| 60 | + |
| 61 | +> Auto-generated by attune-author faithfulness judge. Score 0.83 fell below the configured threshold of 0.95. Review unsupported claims and either fix the source code or fix this doc. |
| 62 | +
|
| 63 | +**Score:** 0.83 (supported: 19, unsupported: 4) |
| 64 | + |
| 65 | +### Unsupported claims |
| 66 | + |
| 67 | +- The bootstrap reference was generated on 2026-07-10T13:07:32.401338+00:00 |
| 68 | +- The source_hash is 40cd7c5eca29231d1a865aa04654239348b46aed8c204904aacc473fc810affe |
| 69 | +- The scaffold_hash is 04376ece60b306ed2326639b284d6f17a8ea83d0455ee27fd1c9ca0edf713c11 |
| 70 | +- The tags are 'setup', 'scanning', 'manifest' |
| 71 | + |
| 72 | +### Reasoning |
| 73 | + |
| 74 | +The answer is primarily a reference documentation table extracted directly from the source code and docstrings provided in the passages. Nearly all technical claims about function signatures, parameter types, return types, dataclass fields, and constant values are explicitly stated in the code or docstrings. However, the generated metadata (generated_at timestamp, source_hash, scaffold_hash) and the tags listed at the bottom are not mentioned in the retrieved passages and appear to be document metadata added during generation rather than factual claims about the code itself. |
0 commit comments