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

[ste100-docs-and-cli-standardization] #02: Reformat Primary User Documentation (README.md and FAQ.md) #16

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/02-reformat-readme-and-faq.md

02: Reformat Primary User Documentation (README.md and FAQ.md)

What to build: Rewrite README.md and FAQ.md in STE-flavored mode (≤25 words per sentence, active voice, no semicolons, no marketing puffery, consistent domain glossary terms, exact CLI command table sync with cli.py).

Blocked by: 01: Standardize CLI Command & Argument Help Strings

Status: closed

  • README.md rewritten with clear active voice and no marketing puffery.
  • Sentence lengths in README.md conform to ≤25 words.
  • CLI cheatsheet table in README.md directly mirrors standardized cli.py descriptions.
  • FAQ.md questions and answers rewritten with STE-flavored structural rules.
  • No semicolons present in README.md or FAQ.md.
**Feature**: `ste100-docs-and-cli-standardization` | **Source**: `.scratch/ste100-docs-and-cli-standardization/issues/02-reformat-readme-and-faq.md` # 02: Reformat Primary User Documentation (README.md and FAQ.md) **What to build:** Rewrite `README.md` and `FAQ.md` in STE-flavored mode (≤25 words per sentence, active voice, no semicolons, no marketing puffery, consistent domain glossary terms, exact CLI command table sync with `cli.py`). **Blocked by:** 01: Standardize CLI Command & Argument Help Strings **Status:** closed - [x] `README.md` rewritten with clear active voice and no marketing puffery. - [x] Sentence lengths in `README.md` conform to ≤25 words. - [x] CLI cheatsheet table in `README.md` directly mirrors standardized `cli.py` descriptions. - [x] `FAQ.md` questions and answers rewritten with STE-flavored structural rules. - [x] No semicolons present in `README.md` or `FAQ.md`.
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
#17 [ste100-docs-and-cli-standardization] #03: Reformat Deep Documentation & Python API Guides
Lavisys/mailsweep
#18 [ste100-docs-and-cli-standardization] #04: Standardize Rules Schema & Agent Operational Documentation
Lavisys/mailsweep
#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
Reference
Lavisys/mailsweep#16
No description provided.