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

Documentation TODO #73

Open
4 of 11 tasks
bvisness opened this issue May 27, 2024 · 0 comments
Open
4 of 11 tasks

Documentation TODO #73

bvisness opened this issue May 27, 2024 · 0 comments

Comments

@bvisness
Copy link
Collaborator

bvisness commented May 27, 2024 •
edited
Loading

I have stolen the list of documentation tasks from #35 to track them here.

  • Update the list of requirements
  • Update the user tooling doc
  • Split and update the dev tooling doc / building instructions to a separate document
  • Update the cheat sheets
  • Comment / write an accompanying tutorial file for each example
  • "Getting Started" files (initially for C, later for other languages)
  • Overview on our core data structures, eg arenas, strings, lists
  • Canvas API documentation. In particular, the affine transform API and the text API might need some more in depth explanations.
  • Setup the infrastructure for a standalone documentation website that we can fill in as we go
  • Full API documentation
  • Convert all function references in the documentation to links to the API spec
This was referenced May 27, 2024
Closed
Open
@martinfouilleul martinfouilleul transferred this issue from another repository May 29, 2024
@martinfouilleul martinfouilleul mentioned this issue Jun 4, 2024
Closed
@martinfouilleul martinfouilleul pinned this issue Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bvisness