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

[FEAT] Set up main API page for each package #2971

Closed
Tracked by #2682 ...
xelaint opened this issue Aug 14, 2024 · 4 comments · Fixed by #2991
Closed
Tracked by #2682 ...

[FEAT] Set up main API page for each package #2971

xelaint opened this issue Aug 14, 2024 · 4 comments · Fixed by #2991
Assignees
Labels
docs This issue is related to documentation feat a new feature, enhancement, or improvement p1 critical priority package: daff.io @daffodil/daff.io status: blocked This PR or issue is blocked and cannot currently be progressed
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Aug 14, 2024

💡 Feature request

Feature Name

Set up main API page for each package

The Desired Behavior

Main API page for each package should include a brief description of what the package is along with a comprehensive list of all the available APIs in the package.

Your Use Case

As a user, I want to see an overview of all the available APIs in a package.

Prior Work

Environment


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

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

Others:

@xelaint xelaint added feat a new feature, enhancement, or improvement docs This issue is related to documentation package: daff.io @daffodil/daff.io labels Aug 14, 2024
@xelaint xelaint added this to the Daffodil v1.0 milestone Aug 14, 2024
@xelaint xelaint self-assigned this Aug 14, 2024
@xelaint xelaint added the p1 critical priority label Aug 14, 2024
@griest024
Copy link
Member

blocked by #2816

@xelaint
Copy link
Member Author

xelaint commented Aug 14, 2024

blocked by #2816

is this a duplicate issue then?

@griest024
Copy link
Member

no, I think this should track the design and daff.io implementation but the other issue tracks actually generating the correct data with dgeni

@xelaint xelaint added the status: blocked This PR or issue is blocked and cannot currently be progressed label Aug 14, 2024
@damienwebdev
Copy link
Member

damienwebdev commented Aug 22, 2024

This depends upon, but is not blocked by #2693

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 feat a new feature, enhancement, or improvement p1 critical priority package: daff.io @daffodil/daff.io status: blocked This PR or issue is blocked and cannot currently be progressed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants