Skip to content

[FRONTEND] Documentation Consistency #39

@binit2-1

Description

@binit2-1

Description

There is currently an inconsistency in how CLI commands are documented across different sections. The "Quick Start" / "Installation" sections include the file path argument, while the specific "Pull/Push Components" sections sometimes omit it or use different placeholder naming.

We need to standardize the syntax to ensure users understand that the file path is a required argument for both operations and explain the context of that path.

Affected pages/components

  • Documentation > Quick Start Section
  • Documentation > CLI Commands > Push Section
  • Documentation > CLI Commands > Pull Section

Current behavior

  • Quick Start/Installation: Shows composter pull <CATEGORY_NAME> <COMPONENT_NAME> <PATH_TO_IMPORT>
  • Pull/Push Sections: Sometimes shows composter pull <category> <component-name> (missing the path argument) or inconsistent casing/placeholders.

Expected behavior

  1. Standardized Syntax: Both sections should use the consistent format:
    • composter push <category-name> <component-name> <file-path>
    • composter pull <category-name> <component-name> <file-path>
  2. Path Clarification: Add a brief description distinguishing the two paths:
    • Push: Explain that <file-path> is the source location of the component you want to upload.
    • Pull: Explain that <file-path> is the destination directory where you want to save the component.

Effected Screenshots

Quick Start Section

Image

CLI section

Image

Acceptance Criteria

  • Update "Quick Start" and "CLI Commands" sections to match the standard syntax above.
  • Ensure placeholders (<category-name>, etc.) are consistent in casing across the docs.
  • Add the explanation regarding Source Path (for push) vs. Destination Path (for pull).
  • PR must include before/after screenshots of the documentation updates.
  • Design Consistency should be maintained

Notes

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions