Docs: Cleaned up some minor issues like docs not being in nav
CI / lint (push) Successful in 16s
CI / typecheck (push) Successful in 24s
CI / security (push) Successful in 16s
CI / quality (push) Successful in 14s
CI / build (push) Successful in 12s
CI / behave (3.13) (push) Successful in 3m48s
CI / docker (push) Successful in 8s
CI / coverage (push) Successful in 4m18s

This commit is contained in:
2026-02-12 11:08:54 -05:00
parent f9d3aa6f3a
commit a4b56fa308
4 changed files with 41 additions and 3491 deletions
+1 -1
View File
@@ -127,7 +127,7 @@ to determine review depth:
### Review Checklist
Every PR should pass this checklist (also available in the
[PR template](../../.forgejo/pull_request_template.md)):
PR template at `.forgejo/pull_request_template.md` in the repository root):
- [ ] Code follows `CONTRIBUTING.md` coding standards
- [ ] All public/protected methods have argument validation
File diff suppressed because it is too large Load Diff
+37 -13
View File
@@ -10231,22 +10231,46 @@ The general software domain defines a base set of named levels. Paradigm-specifi
| 8 | `NEAR_COMPLETE` | + All statements except comments, logging, and boilerplate (imports, `__all__`, etc.). |
| 9 | `FULL_SOURCE` | Complete source code — nothing omitted. |
*Object-Oriented extension (`uko-oo:`) inserts:*
*Object-Oriented effective map (`uko-oo:`) — inherits from `uko-code:`, inserts `CLASS_HIERARCHY` and `VISIBILITY_ANNOTATED`:*
| Depth | `uko-oo:` Name | Content Added |
|-------|-----------------|---------------|
| 2.5 → 3 | `CLASS_HIERARCHY` | Inheritance chains and interface implementation relationships between classes (inserted between `MEMBER_LISTING` and `MEMBER_SUMMARY`, shifting subsequent depths). |
| 5.5 → 6 | `VISIBILITY_ANNOTATED` | Public/protected/private modifiers on all members + abstract/final markers (inserted between `SIGNATURES_WITH_DOCS` and `STRUCTURAL_OUTLINE`). |
When the `uko-oo:` extension is active, the effective DetailLevelMap is re-numbered with consecutive integers. The two inserted levels shift all subsequent depths upward:
*Python-specific extension (`uko-py:`) inserts:*
| Depth | Name | Origin | Content Shown |
|-------|------|--------|---------------|
| 0 | `MODULE_LISTING` | `uko-code:` | Module/package names only, no internal structure. |
| 1 | `MODULE_GRAPH` | `uko-code:` | Module names + inter-module dependency edges (imports graph). |
| 2 | `MEMBER_LISTING` | `uko-code:` | + Names of top-level members within each module (classes, functions, constants) — no signatures. |
| 3 | `CLASS_HIERARCHY` | **`uko-oo:`** | **Inheritance chains and interface implementation relationships between classes.** |
| 4 | `MEMBER_SUMMARY` | `uko-code:` | + One-line docstring or LLM-generated summary for each member. |
| 5 | `SIGNATURES` | `uko-code:` | + Full type signatures (parameter names, types, return types) for all callables and type definitions. |
| 6 | `SIGNATURES_WITH_DOCS` | `uko-code:` | + Complete docstrings/comments attached to each member. |
| 7 | `VISIBILITY_ANNOTATED` | **`uko-oo:`** | **Public/protected/private modifiers on all members + abstract/final markers.** |
| 8 | `STRUCTURAL_OUTLINE` | `uko-code:` | + Control flow structure within callable bodies (branches, loops, try/except) shown as outline, no expressions. |
| 9 | `KEY_LOGIC` | `uko-code:` | + Key expressions: return statements, assertions, assignments to important variables. |
| 10 | `NEAR_COMPLETE` | `uko-code:` | + All statements except comments, logging, and boilerplate (imports, `__all__`, etc.). |
| 11 | `FULL_SOURCE` | `uko-code:` | Complete source code — nothing omitted. |
| Depth | `uko-py:` Name | Content Added |
|-------|-----------------|---------------|
| 5.5 → 6 | `DECORATED_SIGNATURES` | `@property`, `@staticmethod`, `@classmethod`, custom decorator chains shown on each member. |
| 7.5 → 8 | `TYPE_STUBS` | Type annotations from `.pyi` stub files merged with source, `typing` module usage. |
| 10 | `WITH_TESTS` | Full source + associated test cases for each callable (from `uko-code:testsCallable` edges). |
*Python-specific effective map (`uko-py:`) — inherits from `uko-oo:`, inserts `DECORATED_SIGNATURES`, `TYPE_STUBS`, and appends `WITH_TESTS`:*
> **Note on fractional depths**: Fractional values like "2.5" are notational only — they indicate that the extension inserts a new named level between two existing levels, which shifts the integer assignments. The actual registered map uses consecutive integers. For example, when `uko-oo:` is active, what `uko-code:` calls depth 3 (`MEMBER_SUMMARY`) becomes depth 4 in the effective map because `CLASS_HIERARCHY` is inserted at depth 3.
When the `uko-py:` extension is active, the effective map builds on `uko-oo:` and re-numbers again:
| Depth | Name | Origin | Content Shown |
|-------|------|--------|---------------|
| 0 | `MODULE_LISTING` | `uko-code:` | Module/package names only, no internal structure. |
| 1 | `MODULE_GRAPH` | `uko-code:` | Module names + inter-module dependency edges (imports graph). |
| 2 | `MEMBER_LISTING` | `uko-code:` | + Names of top-level members within each module (classes, functions, constants) — no signatures. |
| 3 | `CLASS_HIERARCHY` | `uko-oo:` | Inheritance chains and interface implementation relationships between classes. |
| 4 | `MEMBER_SUMMARY` | `uko-code:` | + One-line docstring or LLM-generated summary for each member. |
| 5 | `SIGNATURES` | `uko-code:` | + Full type signatures (parameter names, types, return types) for all callables and type definitions. |
| 6 | `SIGNATURES_WITH_DOCS` | `uko-code:` | + Complete docstrings/comments attached to each member. |
| 7 | `DECORATED_SIGNATURES` | **`uko-py:`** | **`@property`, `@staticmethod`, `@classmethod`, custom decorator chains shown on each member.** |
| 8 | `VISIBILITY_ANNOTATED` | `uko-oo:` | Public/protected/private modifiers on all members + abstract/final markers. |
| 9 | `STRUCTURAL_OUTLINE` | `uko-code:` | + Control flow structure within callable bodies (branches, loops, try/except) shown as outline, no expressions. |
| 10 | `KEY_LOGIC` | `uko-code:` | + Key expressions: return statements, assertions, assignments to important variables. |
| 11 | `TYPE_STUBS` | **`uko-py:`** | **Type annotations from `.pyi` stub files merged with source, `typing` module usage.** |
| 12 | `NEAR_COMPLETE` | `uko-code:` | + All statements except comments, logging, and boilerplate (imports, `__all__`, etc.). |
| 13 | `FULL_SOURCE` | `uko-code:` | Complete source code — nothing omitted. |
| 14 | `WITH_TESTS` | **`uko-py:`** | **Full source + associated test cases for each callable (from `uko-code:testsCallable` edges).** |
**Document DetailLevelMap (`uko-doc:`):**
@@ -25314,7 +25338,7 @@ The authoritative DetailLevelMap definitions — with full integer depth assignm
*Language-Specific (Layer 3) DetailLevelMap insertions — examples:*
Each language extension may insert additional named levels into its parent paradigm's map (see the fractional-depth insertion mechanism described in Core Data Types). The table below summarizes the key additions:
Each language extension may insert additional named levels into its parent paradigm's map, shifting subsequent depths upward to maintain consecutive integer numbering (see the fully expanded effective maps in Core Data Types). The table below summarizes the key additions:
| Language | Inserted Levels | Additional Content at Those Depths |
|----------|----------------|------------------------------------|
+3 -1
View File
@@ -10,7 +10,9 @@ site_dir: build/site
nav:
- Specification: specification.md
- Implementation Plan: implementation_plan.md
- Development:
- CI/CD Pipeline: development/ci-cd.md
- Quality Automation: development/quality-automation.md
theme:
name: material