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

Overhaul documentation #1

Open
5 tasks
mazziechai opened this issue Mar 27, 2024 · 0 comments
Open
5 tasks

Overhaul documentation #1

mazziechai opened this issue Mar 27, 2024 · 0 comments
Assignees
@mazziechai
Labels
documentation Improvements or additions to documentation

Comments

@mazziechai
Copy link
Member

mazziechai commented Mar 27, 2024 •
edited
Loading

Currently, Meteor's documentation is sparse. This makes it much harder for developers and users to work with.

At minimum, basic documentation should be provided for everything in the library, including internals, to ease development in the future. Public interfaces must include more information, such as appropriate usage.

Modules to document

  • cpu
  • emulator
  • ic
  • ioc
  • mmu
@mazziechai mazziechai added the documentation Improvements or additions to documentation label Mar 27, 2024
@mazziechai mazziechai self-assigned this Mar 27, 2024
@mazziechai mazziechai moved this to Next in Nova & Friends Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mazziechai mazziechai

Labels
documentation Improvements or additions to documentation
Projects
Nova & Friends
Status: Next
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mazziechai