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

Rework Documentation, part 1 #147

Merged
merged 7 commits into from
Sep 2, 2020
Merged

Rework Documentation, part 1 #147

merged 7 commits into from
Sep 2, 2020

Conversation

simu
Copy link
Member

@simu simu commented Jul 23, 2020 •
edited
Loading

This is a first PR working towards completing #120.

This PR contains the following documentation pages:

  • A list of all commands provided by commodore with short explanations of what they do
  • A list of all options for all commands (manpage-inspired)
  • A page documenting Commodore concepts
  • A page documenting Commodore architecture

Checklist

  • Keep pull requests small so they can be easily reviewed.
  • Update the documentation.
  • Update the ./CHANGELOG.md.
  • Link this PR to related issues.

@simu simu marked this pull request as draft July 23, 2020 15:02
@simu simu force-pushed the docs-rework branch 3 times, most recently from 91fe90c to 78995a4 Compare July 30, 2020 15:35
@simu simu changed the title Rework Documentation Rework Documentation, part 1 Jul 31, 2020
@simu simu requested review from tobru, srueg and akosma August 31, 2020 12:13
@simu simu marked this pull request as ready for review August 31, 2020 12:13
tobru
tobru requested changes Aug 31, 2020
View reviewed changes
@tobru tobru mentioned this pull request Aug 31, 2020
Merged
3 tasks
@srueg srueg mentioned this pull request Sep 1, 2020
Merged
@simu simu requested review from srueg and tobru September 1, 2020 13:06
akosma
akosma approved these changes Sep 2, 2020
View reviewed changes
Copy link
Contributor

@akosma akosma left a comment

Choose a reason for hiding this comment

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

LGTM! Very exhaustive and comprehensive. Thanks!

@simu simu merged commit e9dca6d into master Sep 2, 2020
@simu simu deleted the docs-rework branch September 2, 2020 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akosma akosma akosma approved these changes

@srueg srueg srueg approved these changes

@tobru tobru tobru approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@simu @akosma @srueg @tobru