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

API Reference Docs - Docs Revamp #1031

Open
5 of 13 tasks
sufyaankhan opened this issue Mar 25, 2024 · 2 comments
Open
5 of 13 tasks

API Reference Docs - Docs Revamp #1031

sufyaankhan opened this issue Mar 25, 2024 · 2 comments
Assignees
Labels
4day-dapp-mar1 things due march 1st in the 4 day dapp api-docs issues that generated api-docs should address

Comments

@sufyaankhan
Copy link

sufyaankhan commented Mar 25, 2024

  • The developer API product and only the developer API product needs to be documented to fulfill this rock. This requires:
    • The product owners (PM) to definitively determine what portions of the codebase are part of the developer API product & what is the rest of the platform.
    • Reference docs must be auto-generated for the entire developer API product.
    • Code examples for all portions of the developer API product must be linked from the relevant sections of the docs site. Code examples can be a mix of inline examples on the docs site, links to relevant lines of contracts or sample dapps.
@sufyaankhan sufyaankhan added the 4day-dapp-mar1 things due march 1st in the 4 day dapp label Mar 25, 2024
@sufyaankhan sufyaankhan changed the title Docs Revamp Rock - API Reference Docs API Reference Docs - Docs Revamp Mar 25, 2024
@dckc
Copy link
Member

dckc commented Mar 25, 2024

tasks that come to mind:

@dckc
Copy link
Member

dckc commented Mar 26, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4day-dapp-mar1 things due march 1st in the 4 day dapp api-docs issues that generated api-docs should address
Projects
None yet
Development

No branches or pull requests

2 participants