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

[DOCS] Docs describing the API, utilization and examples of the @daffodil/design package #2767

Open
36 of 61 tasks
Tracked by #1925
xelaint opened this issue Mar 4, 2024 · 0 comments
Open
36 of 61 tasks
Tracked by #1925
Assignees
Labels
docs This issue is related to documentation p1 critical priority package: design @daffodil/design
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Mar 4, 2024

📄 Documentation Request

What were you doing?

Expected behavior

Package Docs

For each component

  • Overview with basic examples
  • Overview with general features of the component
  • Overviews should reference token of the API
  • Reference should take you to a separate API page with usage examples
  • Tabs: Usage, API ([FEAT] Tabs Component #3123)

Component Docs

  • Accordion
    • Overview (docs exist, but need more in depth docs)
    • Examples
  • Article
    • Overview
    • Examples
  • Button
    • Overview
    • Examples
  • Callout
    • Overview
    • Examples
  • Card
    • Overview
    • Examples
  • Container
    • Overview (docs exist, but need more in depth docs)
    • Examples
  • Hero
    • Overview
    • Examples
  • Image
    • Overview
    • Examples
  • Input (needs to be refactored, so current docs are irrelevant)
    • Overview
    • Examples
  • Link Set
    • Overview (needs to be cleaned up)
    • Examples (examples need to be moved into its own components so that it can be rendered by the example viewer)
  • List
    • Overview (needs to be cleaned up)
    • Examples (examples need to be moved into its own components so that it can be rendered by the example viewer)
  • Loading Icon
    • Overview (readme file is not up-to-date)
    • Examples
  • Media Gallery
    • Overview
    • Examples
  • Menu
    • Overview (docs exist, but need more in depth docs)
    • Examples
  • Modal
    • Overview (design-land and readme docs are not synced up)
    • Examples
  • Navbar
    • Overview
    • Examples
  • Notification
    • Overview (design-land and readme docs are not synced up)
    • Examples
  • Paginator
    • Overview (design-land and readme docs are not synced up)
    • Examples
  • Quantity Field
    • Overview (design-land and readme docs are not synced up)
    • Examples
  • Radio (needs to be refactored, so current docs are irrelevant)
    • Overview
    • Examples
  • Sidebar
    • Overview
    • Examples
  • Tree
    • Overview
    • Examples

Existing Documentation

Environment


Daffodil version: X.Y.Z
Angular version: X.Y.Z 

 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation p1 critical priority package: design @daffodil/design
Projects
None yet
Development

No branches or pull requests

1 participant