Description
💡 Feature request
Feature Name
Daffodil Packages Explorer
The Desired Behavior
Phase 1 (Design)
- Design the package explorer landing page (PELP) (mock up needed)
- The top nav will utilize the base nav of docs.daff.io where
Packages
is a primary link on the top nav. - A primary landing page that lists out all of the packages.
- An individual package page will have a left sidebar that lists out all the packages so it's easy for developers to find another package.
Phase 2 (Preparation)
- [DOCS] Clean up the overview docs in each Daffodil package #2694
- [FEAT] Docs generation for daff.io packages explorer list #2696
- [BUG] daff.io's package explorer sidebar displays information unrelated to daffodil packages #2685
- [DOCS] Clean up the package descriptions in
package.json
#2693 - [FEAT] Rename all
OVERVIEW.md
files toREADME.md
#2695 - [DOCS] Standardize the default package document list #2813
- [BUG] Links in package guides don't navigate correctly #2815
- [BUG] Daffodil Package API page missing child symbols #2816
- [FEAT] Remove internal packages from packages list in the package explorer #2820
- [BUG]
packages/*
should redirect todocs/packages/*
so that older links continue to work #2849 - [FEAT] Daffodil Design Package Link should link to
/docs/design
#2814
Phase 2.5 (Per Package Preparation)
- [DOCS]
@daffodil/analytics
Standardized Documentation #3005 - [DOCS]
@daffodil/category
Standardized Documentation #2999 - [DOCS]
@daffodil/contact
Standardized Documentation #2821 - [DOCS]
@daffodil/cart
Standardized Documentation #2975 - [FEAT] Set up main API page for each package #2971
- [DOCS] Update installation docs on all packages to include instructions for standalone components #2986
Phase 3 (Implementation)
- Create the route and component for the PELP
- [FEAT] Adjust the route for packages list to
https://next.daff.io/docs/packages
#2818 - [FEAT] Declutter generation for package list assets (package list) #2819
- Modify the docs generation for daff.io to include the package gen assets
Phase 4 (nice to have)
Your Use Case
As a Daffodil core developer, I want to be able to review specific documentation for each Daffodil package.
Prior Work
Environment
Daffodil version: 0.66.1
Angular version: X.Y.Z
For Tooling issues:
- Node version: XX
- Platform:
Others: