Skip to content

Commit 272ba8a

Browse files
committed
Add AI-generated documentation for coding agents
1 parent de33c8e commit 272ba8a

File tree

8 files changed

+4060
-126
lines changed

8 files changed

+4060
-126
lines changed

.ai-docs/architecture.md

Lines changed: 369 additions & 0 deletions
Large diffs are not rendered by default.

.ai-docs/contributor.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributor Guide
2+
3+
*See the project README for contribution guidelines.*

.ai-docs/conventions.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Coding Conventions
2+
3+
> **Note**: This document provides guidance on where to find conventions.
4+
> For specific details, check the referenced files directly.
5+
6+
## Where to Find Conventions
7+
8+
### Naming Patterns
9+
- Check existing files for naming conventions
10+
- Check types definitions for interface organization patterns
11+
12+
### Code Standards
13+
- **Schema Patterns**: Check for schema validation patterns (e.g. Zod)
14+
- **Error Handling**: Review how errors are caught and reported
15+
- **Async Patterns**: Observe how async/await and promises are handled
16+
17+
### UI/UX Patterns
18+
- **State Management**: Review state hooks and context usage
19+
- **Components**: Check shared UI components for reusable patterns
20+
21+
### Integration Patterns
22+
- **API Patterns**: Review API route handlers for request/response structures
23+
- **Data Fetching**: Review how external data is fetched and cached

.ai-docs/dependencies.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Module Dependencies
2+
3+
## System Graph
4+
5+
```mermaid
6+
graph TD
7+
A[root-files]
8+
B[senspy]
9+
C[tests]
10+
D[.github]
11+
E[.claude]
12+
```
13+
14+
## Module Details
15+
16+
### root-files
17+
18+
Files in repository root/
19+
20+
**Depends on:** *(none)*
21+
**Used by:** *(none)*
22+
23+
### senspy
24+
25+
Files in senspy/
26+
27+
**Depends on:** *(none)*
28+
**Used by:** *(none)*
29+
30+
### tests
31+
32+
Files in tests/
33+
34+
**Depends on:** *(none)*
35+
**Used by:** *(none)*
36+
37+
### .github
38+
39+
Files in .github/
40+
41+
**Depends on:** *(none)*
42+
**Used by:** *(none)*
43+
44+
### .claude
45+
46+
Files in .claude/
47+
48+
**Depends on:** *(none)*
49+
**Used by:** *(none)*
50+
51+
## High-Connectivity Files
52+
53+
Files with the highest semantic importance scores, indicating broad connectivity across the codebase.
54+
55+
- `README.md` (score: 0)
56+
- `pyproject.toml` (score: 0)
57+
- `CONTRIBUTING.md` (score: 0)
58+
- `mkdocs.yml` (score: 0)
59+
- `senspy/__init__.py` (score: 0)
60+
- `senspy/anota.py` (score: 0)
61+
- `senspy/betabin.py` (score: 0)
62+
- `senspy/discrim.py` (score: 0)
63+
- `senspy/dod.py` (score: 0)
64+
- `senspy/dprime_tests.py` (score: 0)

.ai-docs/gotchas.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Gotchas & Caveats
2+
3+
This document covers non-obvious behaviors, edge cases, and things to watch out for.
4+
5+
*No specific gotchas were identified during documentation generation.*

.ai-docs/manifest.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Codebase Manifest
2+
3+
> Auto-generated documentation for **aigorahub/sensPy**
4+
5+
## Directory Structure
6+
7+
- **`root/`** (4 files): Files in repository root/
8+
- **`senspy/`** (22 files): Files in senspy/
9+
- **`tests/`** (26 files): Files in tests/
10+
- **`.github/`** (8 files): Files in .github/
11+
- **`.claude/`** (1 file): Files in .claude/
12+
13+
## Key Entry Points
14+
15+
*No entry points identified in skeleton.*
16+
17+
## Module File Index
18+
19+
### root-files
20+
21+
- `README.md`
22+
- `pyproject.toml`
23+
- `CONTRIBUTING.md`
24+
- `mkdocs.yml`
25+
26+
### senspy
27+
28+
- `senspy/__init__.py`
29+
- `senspy/anota.py`
30+
- `senspy/betabin.py`
31+
- `senspy/discrim.py`
32+
- `senspy/dod.py`
33+
- `senspy/dprime_tests.py`
34+
- `senspy/plotting.py`
35+
- `senspy/power.py`
36+
- `senspy/protocol_power.py`
37+
- `senspy/roc.py`
38+
- `senspy/samediff.py`
39+
- `senspy/simulation.py`
40+
- `senspy/twoac.py`
41+
- `senspy/core/__init__.py`
42+
- `senspy/core/base.py`
43+
- `senspy/core/types.py`
44+
- `senspy/links/__init__.py`
45+
- `senspy/links/double.py`
46+
- `senspy/links/psychometric.py`
47+
- `senspy/utils/__init__.py`
48+
- `senspy/utils/stats.py`
49+
- `senspy/utils/transforms.py`
50+
51+
### tests
52+
53+
- `tests/__init__.py`
54+
- `tests/conftest.py`
55+
- `tests/test_anota.py`
56+
- `tests/test_betabin.py`
57+
- `tests/test_coverage_discrim.py`
58+
- `tests/test_coverage_dod.py`
59+
- `tests/test_coverage_links.py`
60+
- `tests/test_coverage_power.py`
61+
- `tests/test_coverage_samediff.py`
62+
- `tests/test_coverage_utils.py`
63+
- `tests/test_discrim.py`
64+
- `tests/test_dod.py`
65+
- `tests/test_double_links.py`
66+
- `tests/test_dprime_tests.py`
67+
- `tests/test_links.py`
68+
- `tests/test_plotting.py`
69+
- `tests/test_power.py`
70+
- `tests/test_protocol_power.py`
71+
- `tests/test_roc.py`
72+
- `tests/test_samediff.py`
73+
- `tests/test_sensr_validation.py`
74+
- `tests/test_simulation.py`
75+
- `tests/test_twoac.py`
76+
- `tests/test_types.py`
77+
- `tests/test_utils.py`
78+
- `tests/fixtures/golden_sensr.json`
79+
80+
### .github
81+
82+
- `.github/ISSUE_TEMPLATE/bug_report.md`
83+
- `.github/pull_request_template.md`
84+
- `.github/workflows/auto-comment-gemini-review.yml`
85+
- `.github/workflows/claude-code-review.yml`
86+
- `.github/workflows/claude.yml`
87+
- `.github/workflows/docs.yml`
88+
- `.github/workflows/publish.yml`
89+
- `.github/workflows/pytest.yml`
90+
91+
### .claude
92+
93+
- `.claude/settings.local.json`

0 commit comments

Comments
 (0)