Skip to content

Docs: Standardize parameter naming conventions across documentation #65

@kluth

Description

@kluth

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

  1. Cache size:

    • Sometimes: maxSize
    • Sometimes: cacheSize
    • Sometimes: size
  2. Time-to-live:

    • Sometimes: defaultTTL
    • Sometimes: ttl
    • Sometimes: TTL
  3. Theme/styling:

    • Sometimes: darkMode
    • Sometimes: dark
    • Sometimes: theme
  4. Secrets/keys:

    • Sometimes: secretKey
    • Sometimes: secret
    • Sometimes: key
  5. Cache references:

    • Sometimes: this.cache.get()
    • Sometimes: astrocyte.get()

Recommended Action

  1. Establish naming conventions document
  2. Choose canonical names for common parameters
  3. Update all documentation to use consistent names
  4. Add glossary of standard terminology
  5. 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

  • Create naming conventions document
  • Audit all documentation for inconsistencies
  • Standardize parameter names
  • Add glossary to documentation
  • Create documentation style guide
  • Apply conventions to all examples

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestlowLow priority - backlog

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions