Skip to content
This repository has been archived by the owner on May 29, 2020. It is now read-only.

The documentation #9

Open
3 of 15 tasks
Fingercomp opened this issue Aug 1, 2018 · 0 comments
Open
3 of 15 tasks

The documentation #9

Fingercomp opened this issue Aug 1, 2018 · 0 comments
Labels
help wanted wonderful Issues regarding everything in wonderful besides the code wonderfully hard

Comments

@Fingercomp
Copy link
Member

I believe the documentation is as important as the code itself. Especially for complex projects like this one. They should be comprehensive, organized, yet fun to read.

  • Introduction
  • Feature list
  • Reference; in-code documentation
  • Glossary (to be consistent)
  • Quickstart
  • Tutorial
    • Documents
    • Components and Layouts
    • Rendering
    • Component Attribute System
    • Buffer
    • Extending
  • Maintainer's Guide (how things work, explained from the maintainer's point of view)
    • How Buffer Works
    • Render Cycle
    • ...
@Fingercomp Fingercomp added this to the wonderful-core 0.1.0 milestone Aug 1, 2018
@Fingercomp Fingercomp added the wonderful Issues regarding everything in wonderful besides the code label Aug 2, 2018
@Fingercomp Fingercomp removed this from the wonderful-core 0.1.0 milestone Aug 2, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
help wanted wonderful Issues regarding everything in wonderful besides the code wonderfully hard
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Fingercomp