Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Usage documentation for all components #999

Open
11 of 23 tasks
david-poindexter opened this issue Mar 9, 2024 · 0 comments
Open
11 of 23 tasks

Improve Usage documentation for all components #999

david-poindexter opened this issue Mar 9, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@david-poindexter
Copy link
Contributor

david-poindexter commented Mar 9, 2024

Improve Usage documentation for all components. Within StencilJS is a convention for documentation that allows individual usage examples to be located within a usage folder for each component. The file name is used as a title for each example within the Usage section of the component auto-generated portion of the readme.md. For now, we can stick with the following two usage example filenames:

  • HTML.md
  • JSX-TSX.md

Using ALL CAPS seems to keep the titles from translating to Title Case.

Tasks

  1. david-poindexter
  2. enhancement
    david-poindexter
  3. enhancement
    david-poindexter
  4. enhancement
    david-poindexter
  5. enhancement
    david-poindexter
  6. enhancement
    david-poindexter
  7. enhancement
    david-poindexter
  8. enhancement
    david-poindexter
  9. enhancement
    david-poindexter
  10. enhancement
    david-poindexter
  11. enhancement
    david-poindexter
  12. enhancement
    david-poindexter
  13. enhancement
    david-poindexter
  14. enhancement
    david-poindexter
  15. enhancement
    david-poindexter
  16. enhancement
    david-poindexter
  17. enhancement
    david-poindexter
  18. enhancement
    david-poindexter
  19. enhancement
    david-poindexter
  20. enhancement
    david-poindexter
  21. enhancement
    david-poindexter
  22. enhancement
    david-poindexter
  23. enhancement
    david-poindexter
@david-poindexter david-poindexter added the enhancement New feature or request label Mar 9, 2024
@david-poindexter david-poindexter modified the milestones: 0.23.4, 0.24.0 Mar 9, 2024
@david-poindexter david-poindexter self-assigned this Apr 5, 2024
@valadas valadas removed this from the 0.24.0 milestone Jul 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants