Skip to content

New docs site #4312

Description

@brian-smith-tcril

Planning issue to discuss what we're looking for in a new docs site.

  • Things we should keep
    • Live editable code examples
    • Runtime theme loading/switching
    • Usage guidelines
      • Opportunity to improve as we go
  • Things we should add
    • Real-world examples
      • Like usage insights but better
        • With frontend-base converted frontend apps we might be able to do this by importing components from npm published apps.
    • Recommended ways to use something (in comparison to all the different ways it is used throughout frontend apps)
      • Clear distinction between human recommendations and machine gathered usage data
        • How to classify? Way to say "this is good, we should consider how to better support this in/with paragon" and "we haven't looked at this, we should see if this is a bad pattern we should try to replace" etc.
  • Things we should change
    • Structure (follow atomic design hierarchy)
  • Things we should remove
    • //todo

Other thoughts:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions