Problem
Inconsistent parameter naming across documentation makes it harder to follow and remember API patterns.
Affected Files
Multiple documentation files show naming inconsistencies
Issue Details
Severity: LOW
Impact: Affects readability and consistency
Examples of Inconsistency
-
Cache size:
- Sometimes:
maxSize
- Sometimes:
cacheSize
- Sometimes:
size
-
Time-to-live:
- Sometimes:
defaultTTL
- Sometimes:
ttl
- Sometimes:
TTL
-
Theme/styling:
- Sometimes:
darkMode
- Sometimes:
dark
- Sometimes:
theme
-
Secrets/keys:
- Sometimes:
secretKey
- Sometimes:
secret
- Sometimes:
key
-
Cache references:
- Sometimes:
this.cache.get()
- Sometimes:
astrocyte.get()
Recommended Action
- Establish naming conventions document
- Choose canonical names for common parameters
- Update all documentation to use consistent names
- Add glossary of standard terminology
- Create style guide for documentation writers
Priority
LOW - Long-term consistency improvement
References
User Story
As a developer learning the framework, I want consistent parameter naming, so that I can easily remember and predict API patterns across different systems.
Acceptance Criteria
Problem
Inconsistent parameter naming across documentation makes it harder to follow and remember API patterns.
Affected Files
Multiple documentation files show naming inconsistencies
Issue Details
Severity: LOW
Impact: Affects readability and consistency
Examples of Inconsistency
Cache size:
maxSizecacheSizesizeTime-to-live:
defaultTTLttlTTLTheme/styling:
darkModedarkthemeSecrets/keys:
secretKeysecretkeyCache references:
this.cache.get()astrocyte.get()Recommended Action
Priority
LOW - Long-term consistency improvement
References
/home/matthias/projects/synapse/DOCUMENTATION_ISSUE_LOG.md(Issue Claude/review approach terminology 011 c ur yth dd jv kkf b4sx gxr1 #15)/home/matthias/projects/synapse/DOCUMENTATION_FIXES_NEEDED.md(FIX-15)User Story
As a developer learning the framework, I want consistent parameter naming, so that I can easily remember and predict API patterns across different systems.
Acceptance Criteria