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

docs: improving documentation #64

Merged
merged 4 commits into from
Jul 4, 2022
Merged

docs: improving documentation #64

merged 4 commits into from
Jul 4, 2022

Conversation

danbugs
Copy link
Collaborator

@danbugs danbugs commented Jun 30, 2022

This is the first step towards closing #49

It includes:

  • increased comments throughout code,
  • created LICENSE.md,
  • created CONTRIBUTING.md,
  • improved README.md,
  • deleted our design principles document (has to be re-made), and
  • tiny modifications to our primer.

@danbugs danbugs added the 📚 docs Improvements or additions to documentation label Jun 30, 2022
@danbugs danbugs added this to the July Milestone milestone Jun 30, 2022
@danbugs danbugs requested review from devigned and Mossaka June 30, 2022 22:53
Signed-off-by: Dan Chiarlone <[email protected]>
Copy link
Member

@Mossaka Mossaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice PR. Great to see more comments and docs are putting to the project!

@danbugs danbugs merged commit 15c8f78 into main Jul 4, 2022
danbugs added a commit that referenced this pull request Jul 4, 2022
@danbugs danbugs deleted the danbugs/documentation branch July 4, 2022 16:22
danbugs added a commit that referenced this pull request Jul 4, 2022
* added comments to stuff under crates/

Signed-off-by: Dan Chiarlone <[email protected]>

* first draft on CONTRIBUTING, CODE_OF_CONDUCT, and LICENSE docs

Signed-off-by: Dan Chiarlone <[email protected]>

* updated README, removed old design principles file (we have to remake it), and updated primer a bit

Signed-off-by: Dan Chiarlone <[email protected]>

* cargo fmt and cargo clippy

Signed-off-by: Dan Chiarlone <[email protected]>

fixing typo

Signed-off-by: Dan Chiarlone <[email protected]>
danbugs added a commit that referenced this pull request Jul 4, 2022
* added comments to stuff under crates/

Signed-off-by: Dan Chiarlone <[email protected]>

* first draft on CONTRIBUTING, CODE_OF_CONDUCT, and LICENSE docs

Signed-off-by: Dan Chiarlone <[email protected]>

* updated README, removed old design principles file (we have to remake it), and updated primer a bit

Signed-off-by: Dan Chiarlone <[email protected]>

* cargo fmt and cargo clippy

Signed-off-by: Dan Chiarlone <[email protected]>

fixing typo

Signed-off-by: Dan Chiarlone <[email protected]>

small changes

Signed-off-by: Dan Chiarlone <[email protected]>
danbugs added a commit that referenced this pull request Jul 4, 2022
* added comments to stuff under crates/

Signed-off-by: Dan Chiarlone <[email protected]>

* first draft on CONTRIBUTING, CODE_OF_CONDUCT, and LICENSE docs

Signed-off-by: Dan Chiarlone <[email protected]>

* updated README, removed old design principles file (we have to remake it), and updated primer a bit

Signed-off-by: Dan Chiarlone <[email protected]>

* cargo fmt and cargo clippy

Signed-off-by: Dan Chiarlone <[email protected]>

fixing typo

Signed-off-by: Dan Chiarlone <[email protected]>

small changes

Signed-off-by: Dan Chiarlone <[email protected]>

small typo

Signed-off-by: Dan Chiarlone <[email protected]>
danbugs added a commit that referenced this pull request Jul 4, 2022
* added comments to stuff under crates/

Signed-off-by: Dan Chiarlone <[email protected]>

* first draft on CONTRIBUTING, CODE_OF_CONDUCT, and LICENSE docs

Signed-off-by: Dan Chiarlone <[email protected]>

* updated README, removed old design principles file (we have to remake it), and updated primer a bit

Signed-off-by: Dan Chiarlone <[email protected]>

* cargo fmt and cargo clippy

Signed-off-by: Dan Chiarlone <[email protected]>

fixing typo

Signed-off-by: Dan Chiarlone <[email protected]>

small changes

Signed-off-by: Dan Chiarlone <[email protected]>

small typo

Signed-off-by: Dan Chiarlone <[email protected]>

small changes

Signed-off-by: Dan Chiarlone <[email protected]>
danbugs added a commit that referenced this pull request Jul 4, 2022
* added comments to stuff under crates/

Signed-off-by: Dan Chiarlone <[email protected]>

* first draft on CONTRIBUTING, CODE_OF_CONDUCT, and LICENSE docs

Signed-off-by: Dan Chiarlone <[email protected]>

* updated README, removed old design principles file (we have to remake it), and updated primer a bit

Signed-off-by: Dan Chiarlone <[email protected]>

* cargo fmt and cargo clippy

Signed-off-by: Dan Chiarlone <[email protected]>

fixing typo

Signed-off-by: Dan Chiarlone <[email protected]>

small changes

Signed-off-by: Dan Chiarlone <[email protected]>

small typo

Signed-off-by: Dan Chiarlone <[email protected]>

small changes

Signed-off-by: Dan Chiarlone <[email protected]>

Adding issue templates

This makes it easier to create bugs and proposals (i.e., issues not yet assigned as "good first issue", "more involved issue", or "maintainer issue").

updating issue names on CONTRIBUTING.md file

Signed-off-by: Dan Chiarlone <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants