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

Create API docs for published APIs #53

Open
3 tasks
Narigo opened this issue Sep 12, 2024 · 1 comment · May be fixed by #54
Open
3 tasks

Create API docs for published APIs #53

Narigo opened this issue Sep 12, 2024 · 1 comment · May be fixed by #54
Assignees
@nidhal-labidi

Comments

@Narigo
Copy link
Member

Narigo commented Sep 12, 2024

Description

We expose a few functions and types. All of this should be documented. If we document this with JSDoc, we should be able to generate nice API docs

Links / References

  • Search for JSDocs and generators

Tasks / Definition of Done

  • Document all exposed APIs
  • Generate HTML from the JSDoc
  • Link to the generated HTML or allow it to be browsed from the GitHub repo or (preferably) from flottform.io

Further information

On the developer page, outlining the general usage and examples, this should be linked as well.
@Narigo Narigo added the ⚡ new New tasks that were recently added and need attention from project management label Sep 12, 2024
@nidhal-labidi nidhal-labidi linked a pull request Sep 18, 2024 that will close this issue
Open
3 tasks
@Narigo Narigo removed the ⚡ new New tasks that were recently added and need attention from project management label Oct 14, 2024
@TamaraBogantseva
Copy link
Contributor

We will have another issue for improving the docs, but we need to publish this one in order to have some documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nidhal-labidi nidhal-labidi

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

wip: create the documentation for the module 'forms' in flottform compose-us/flottform
3 participants
@Narigo @TamaraBogantseva @nidhal-labidi