Lavisys/mailsweep
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases 7 Packages Wiki Activity Actions

[ste100-docs-and-cli-standardization] #03: Reformat Deep Documentation & Python API Guides #17

New issue
Closed
opened 2026-08-28 17:32:18 +03:00 by jalmari · 0 comments
jalmari commented 2026-08-28 17:32:18 +03:00
Owner
Copy link

Feature: ste100-docs-and-cli-standardization | Source: .scratch/ste100-docs-and-cli-standardization/issues/03-reformat-deep-docs-and-api.md

03: Reformat Deep Documentation & Python API Guides

What to build: Standardize docs/cli-reference.md, docs/python-api.md, docs/internals.md, and docs/Home.md using STE rules, aligning command examples and Python API usage with CONTEXT.md vocabulary.

Blocked by: 01: Standardize CLI Command & Argument Help Strings, 02: Reformat Primary User Documentation

Status: closed

  • docs/cli-reference.md rewritten with imperative flag descriptions matching cli.py.
  • docs/python-api.md updated with clear SVO sentences and deep-module domain vocabulary.
  • docs/internals.md and docs/Home.md restructured to eliminate run-on sentences and banned punctuation.
  • All relative markdown links and cross-references verified.
**Feature**: `ste100-docs-and-cli-standardization` | **Source**: `.scratch/ste100-docs-and-cli-standardization/issues/03-reformat-deep-docs-and-api.md` # 03: Reformat Deep Documentation & Python API Guides **What to build:** Standardize `docs/cli-reference.md`, `docs/python-api.md`, `docs/internals.md`, and `docs/Home.md` using STE rules, aligning command examples and Python API usage with `CONTEXT.md` vocabulary. **Blocked by:** 01: Standardize CLI Command & Argument Help Strings, 02: Reformat Primary User Documentation **Status:** closed - [x] `docs/cli-reference.md` rewritten with imperative flag descriptions matching `cli.py`. - [x] `docs/python-api.md` updated with clear SVO sentences and deep-module domain vocabulary. - [x] `docs/internals.md` and `docs/Home.md` restructured to eliminate run-on sentences and banned punctuation. - [x] All relative markdown links and cross-references verified.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
develop
v0.1.6
v0.1.5
v0.1.4
v0.1.3
v0.1.2
v0.1.1
v0.1.0
Labels
Clear labels   
completed
Resolved and completed

  
feature
Feature epic or workstream

  
needs-info
Waiting for information

  
needs-triage
Needs triage assessment

  
ready-for-agent
Ready for automated agent execution

  
ready-for-human
Requires human decision or execution

  
spec
Feature specification

  
wontfix
Will not fix

No labels
completed
feature
needs-info
needs-triage
ready-for-agent
ready-for-human
spec
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks
#19 [ste100-docs-and-cli-standardization] #05: Verify Domain Glossary Synchronization and Test Suite Integrity
Lavisys/mailsweep
Depends on
#15 [ste100-docs-and-cli-standardization] #01: Standardize CLI Command & Argument Help Strings
Lavisys/mailsweep
#16 [ste100-docs-and-cli-standardization] #02: Reformat Primary User Documentation (README.md and FAQ.md)
Lavisys/mailsweep
Reference
Lavisys/mailsweep#17
No description provided.