Skip to content

[Docs]: components.json proper documentation #121

@btc-echo-ben

Description

@btc-echo-ben

Component name

No response

Current documentation state

The component.json is explained very minimally.
This makes it hard to correctly configure.

Proposed improvement

Please add the following:

  • Where does the cli look exactly for the components.json? in the current process working directory?
  • What is each of the properties for and give some examples.

It would be great if you could already provide some answers in the issue so that we can move on with implementing untitled ui on our end.

Related issue: #120

Priority level

None

Improvement type

  • Add missing information
  • Fix incorrect information
  • Improve clarity and readability
  • Add more examples
  • Improve organization/structure
  • Add visual aids (diagrams, screenshots)
  • Add accessibility information
  • Add performance considerations
  • Add troubleshooting information
  • Add migration information

Contribution

  • I'm willing to write the documentation
  • I'm willing to review proposed changes
  • I'm willing to provide examples
  • I'm willing to help with proofreading

Reference examples

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions