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

Investigate creating templates and guidelines for JavaScript API docs #1737

Open
heitortsergent opened this issue Sep 23, 2024 · 0 comments
Open

Investigate creating templates and guidelines for JavaScript API docs #1737

heitortsergent opened this issue Sep 23, 2024 · 0 comments
Assignees
@heitortsergent @oleiade
Labels
Area: OSS Content Improvements or additions to community/oss documentation type/docs

Comments

@heitortsergent
Copy link
Collaborator

Investigate if we can create templates that would help us with consistency when creating/editing JavaScript API pages.

For example:

  • Some pages have functions that include parameters (some have spaces between the parenthesis and the parameters), and some don't.
  • Some pages have different headings in their parameters or functions tables.
@heitortsergent heitortsergent added Area: OSS Content Improvements or additions to community/oss documentation type/docs labels Sep 23, 2024
@heitortsergent heitortsergent changed the title Investigate creating templates for JavaScript API docs Investigate creating templates and guidelines for JavaScript API docs Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@heitortsergent heitortsergent

@oleiade oleiade

Labels
Area: OSS Content Improvements or additions to community/oss documentation type/docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@heitortsergent @oleiade