Arkasha
c095560e13
- Extract file-level docstrings from Python files (module-level string expressions) - Use __init__.py docstrings as module doc_summary - Use file docstrings as file purpose in layout tables (instead of 'Source file') - Populate module outbound_modules/inbound_modules from import edges (internal only) - Make filename sanitization consistent (sanitize_for_link matches sanitize_filename) - Clean up stale .md files from previous runs before generating - Fill ARCHITECTURE.md template with real layout, modules index, and critical points - Add file_docstring field to ParsedModule and file_purpose to FileDoc
75 lines
1.8 KiB
Markdown
75 lines
1.8 KiB
Markdown
# ARCHITECTURE — New Project
|
||
|
||
<!-- MANUAL:BEGIN -->
|
||
## Project summary
|
||
**Name:** New Project
|
||
**Description:** <FILL_MANUALLY: what this project does in 3–7 lines>
|
||
|
||
## Key decisions (manual)
|
||
- <FILL_MANUALLY>
|
||
|
||
## Non-goals (manual)
|
||
- <FILL_MANUALLY>
|
||
<!-- MANUAL:END -->
|
||
|
||
---
|
||
|
||
## Document metadata
|
||
- **Created:** 2026-01-25
|
||
- **Updated:** 2026-02-15
|
||
- **Generated by:** archdoc (cli) v0.1
|
||
|
||
---
|
||
|
||
## Rails / Tooling
|
||
<!-- ARCHDOC:BEGIN section=rails -->
|
||
|
||
No tooling information available.
|
||
<!-- ARCHDOC:END section=rails -->
|
||
|
||
---
|
||
|
||
## Repository layout (top-level)
|
||
<!-- ARCHDOC:BEGIN section=layout -->
|
||
|
||
| Path | Purpose | Link |
|
||
|------|---------|------|
|
||
| ./src/__init__.py | Test project package. | [details](docs/architecture/files/src____init__.py.md) |
|
||
| ./src/utils.py | Utility functions for the test project. | [details](docs/architecture/files/src__utils.py.md) |
|
||
| ./src/core.py | Core module with database and HTTP integrations. | [details](docs/architecture/files/src__core.py.md) |
|
||
<!-- ARCHDOC:END section=layout -->
|
||
|
||
---
|
||
|
||
## Modules index
|
||
<!-- ARCHDOC:BEGIN section=modules_index -->
|
||
|
||
| Module | Symbols | Inbound | Outbound | Link |
|
||
|--------|---------|---------|----------|------|
|
||
| core | 6 | 0 | 0 | [details](docs/architecture/modules/core.md) |
|
||
| utils | 4 | 0 | 0 | [details](docs/architecture/modules/utils.md) |
|
||
| src | 0 | 0 | 0 | [details](docs/architecture/modules/src.md) |
|
||
<!-- ARCHDOC:END section=modules_index -->
|
||
|
||
---
|
||
|
||
## Critical dependency points
|
||
<!-- ARCHDOC:BEGIN section=critical_points -->
|
||
|
||
### High Fan-in (Most Called)
|
||
| Symbol | Fan-in | Critical |
|
||
|--------|--------|----------|
|
||
|
||
### High Fan-out (Calls Many)
|
||
| Symbol | Fan-out | Critical |
|
||
|--------|---------|----------|
|
||
|
||
### Module Cycles
|
||
<!-- ARCHDOC:END section=critical_points -->
|
||
|
||
---
|
||
|
||
<!-- MANUAL:BEGIN -->
|
||
## Change notes (manual)
|
||
- <FILL_MANUALLY>
|
||
<!-- MANUAL:END --> |