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.

Sign up for GitHub

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

Jump to bottom

API docs design revamp #13548

Closed
5 of 7 tasks
kaviththiranga opened this issue Feb 11, 2019 · 3 comments · Fixed by #15515
Closed
5 of 7 tasks

API docs design revamp #13548

kaviththiranga opened this issue Feb 11, 2019 · 3 comments · Fixed by #15515
Assignees
@hevayo @kaviththiranga
Labels
Planning/SwanLakeDump All issues planned for Swan Lake GA release Team/DevTools Ballerina Developer Tooling ( CLI, Test FW, Package Management, OpenAPI, APIDocs ) Type/Improvement

Comments

@kaviththiranga
Copy link
Contributor

kaviththiranga commented Feb 11, 2019 •
edited
Loading

This is an effort to improve the API documentation of ballerina.

Fixes for current Doc Generation

  • Fix construct categories (eg:Client , Errors)
  • improve TOC structure
    - make categories prominent

Improve Doc Generation

  • Come up with a spec on what to expect with docs
  • Study Docusaurus markdown format for adaptability.
  • Generate MD before generating the actual HTML documents.

Improve Navigation in API Docs

  • Make top level categories in the left hand menu prominent
  • Separate constructs based on their type.
This was referenced Feb 11, 2019
Closed
Closed
@kaviththiranga kaviththiranga mentioned this issue Feb 25, 2019
Closed
24 tasks
@kaviththiranga
Copy link
Contributor Author

Spec will be drafted at https://docs.google.com/document/d/1eyiduNRrUtqoL_e9AksM8B3ClRW0T-RzTrH_qwJZZjU/edit?usp=sharing

@kaviththiranga kaviththiranga mentioned this issue Mar 1, 2019
Closed
36 tasks
@shafreenAnfar shafreenAnfar mentioned this issue Mar 4, 2019
Closed
This was referenced Mar 19, 2019
Closed
Closed
@kaviththiranga kaviththiranga mentioned this issue Mar 29, 2019
Closed
32 tasks
@kaviththiranga kaviththiranga mentioned this issue Jun 5, 2019
Merged
14 tasks
@kaviththiranga
Copy link
Contributor Author

Reopening as there are more subtasks left - this was closed automatically due to PR comment.

@kaviththiranga kaviththiranga reopened this Jun 6, 2019
@anupama-pathirage anupama-pathirage added the Team/CompilerFETools Semantic API, Formatter, Shell label Aug 5, 2019
@srsharon srsharon removed their assignment Nov 1, 2019
@hevayo hevayo added the Planning/SwanLakeDump All issues planned for Swan Lake GA release label Aug 25, 2020
@anupama-pathirage anupama-pathirage added Team/DevTools Ballerina Developer Tooling ( CLI, Test FW, Package Management, OpenAPI, APIDocs ) and removed Team/CompilerFETools Semantic API, Formatter, Shell labels Mar 1, 2021
@hevayo
Copy link
Contributor

hevayo commented Mar 15, 2021

outdated

@hevayo hevayo closed this as completed Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hevayo hevayo

@kaviththiranga kaviththiranga

Labels
Planning/SwanLakeDump All issues planned for Swan Lake GA release Team/DevTools Ballerina Developer Tooling ( CLI, Test FW, Package Management, OpenAPI, APIDocs ) Type/Improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

API Docs Design Revamp kaviththiranga/ballerina-1
5 participants
@hevayo @kaviththiranga @srsharon @praneesha @anupama-pathirage