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

General overhaul / cleanup of docs #43

Open
ian-h-chamberlain opened this issue Sep 20, 2020 · 0 comments
Open

General overhaul / cleanup of docs #43

ian-h-chamberlain opened this issue Sep 20, 2020 · 0 comments
Assignees
@ian-h-chamberlain
Labels
documentation Improvements or additions to documentation tech-debt Cleanup tasks or quality-of-life improvements
Milestone
Build out the cor...

Comments

@ian-h-chamberlain
Copy link
Member

ian-h-chamberlain commented Sep 20, 2020 •
edited
Loading

Probably blocked by #42 since the external-facing API is still in a lot of flux. But in general the cargo-generated documentation should be at a place where multiple types of clients could use it (and in theory a new developer could come in and write a new app against the library).

Also related to #17 – basic documentation should be published to the site via github pages if possible.

Finally, this issue should also be used to add/update a proper CHANGELOG.md. The one in the vscode-redcode repo is probably a good example.
@ian-h-chamberlain ian-h-chamberlain self-assigned this Sep 20, 2020
@ian-h-chamberlain ian-h-chamberlain added the tech-debt Cleanup tasks or quality-of-life improvements label Sep 20, 2020
@ian-h-chamberlain ian-h-chamberlain added the documentation Improvements or additions to documentation label Oct 12, 2020
ian-h-chamberlain added a commit that referenced this issue Sep 25, 2021
@ian-h-chamberlain
Fix remaining clippy lints
5df673c 
Exceptions:
- Docs-related lints, which will are tracked in #43
- Cast-related lints (mostly i32 <-> u32), which will be tracked in a
  new issue
@ian-h-chamberlain ian-h-chamberlain mentioned this issue Sep 25, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ian-h-chamberlain ian-h-chamberlain

Labels
documentation Improvements or additions to documentation tech-debt Cleanup tasks or quality-of-life improvements
Projects
None yet
Milestone
Build out the corewa.rs website
Development

No branches or pull requests
1 participant
@ian-h-chamberlain