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.

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

External Documentation (I.e not rustdoc) #15

Open
Restioson opened this issue Nov 28, 2017 · 2 comments
Open

External Documentation (I.e not rustdoc) #15

Restioson opened this issue Nov 28, 2017 · 2 comments
Labels

Comments

@Restioson
Copy link
Member

Should we write a 'book'-escque doc using mdbook? I could host a rendered version.

@Restioson Restioson added the meta label Dec 11, 2017
@Restioson
Copy link
Member Author

Okay, I'm starting to this would be useful for putting miscellaneous information on how to build and run etc. It'd be nicer than doing it all in the readme. On that note we should document the log levels.

@Restioson Restioson changed the title Mdbook? External Documentation (I.e not rustdoc) May 14, 2018
@Restioson
Copy link
Member Author

This would be very useful for those wanting to contribute, and ourselves. We could include information on where the heap is set up, how the buddy allocator works, and other information we think is needed. We can evolve this as we fix more bugs and figure out a "what have you tried" list, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant