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

Create documentation using mdoc and Docusaurus #125

Merged
merged 8 commits into from
Jul 31, 2020
Merged

Create documentation using mdoc and Docusaurus #125

merged 8 commits into from
Jul 31, 2020

Conversation

robinraju
Copy link
Contributor

No description provided.

robinraju and others added 6 commits July 30, 2020 12:36
@robinraju @eloots
Create and configure Docusaurus documentation
dc1948a
@eloots
Add mdoc/First updates to documentation content
d1a43b3
@eloots
Add more content to Introduction section
ab77691
@eloots
Adding content
d475ead 
- Add sections in CMT command reference documentation
- Add illustrations
- Add examples
- Save an Excel spreadsheet to contain sheets with tables
  for documentation purposes
@eloots
Formatting
e93ebf7
@eloots
Finish adding all cmt-mainadm options to reference documentation
2cabca4 
- Added all cases except for -amc (which needs a thorough review...
@eloots eloots marked this pull request as draft July 30, 2020 12:24
robinraju
robinraju commented Jul 31, 2020
View reviewed changes
Copy link
Contributor Author

@robinraju robinraju left a comment

Choose a reason for hiding this comment

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

Added a few comments and so far looks good to me

Looks like these files got added accidentally

  • images/cmt-mainadm-samples-for-documentation purposes.xlsx
  • images/Lin-Delin.graffle
  • website/static/img/build.graffle

docs/getting_started.md Outdated Show resolved Hide resolved
docs/reference-studentify.md Outdated Show resolved Hide resolved
@eloots eloots marked this pull request as ready for review July 31, 2020 12:19
robinraju
robinraju commented Jul 31, 2020
View reviewed changes
Copy link
Contributor Author

@robinraju robinraju left a comment

Choose a reason for hiding this comment

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

LGTM ✅

Since I created this PR with an initial commit, Github is preventing me from approve it 😆

@robinraju robinraju requested a review from eloots July 31, 2020 13:13
@eloots
Copy link
Collaborator

eloots commented Jul 31, 2020

Since I created this PR with an initial commit, Github is preventing me from approve it 😆

Then I'll review my own changes!

😂

@eloots eloots merged commit 8507ac2 into main Jul 31, 2020
@eloots eloots deleted the documentation branch July 31, 2020 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eloots eloots eloots 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.
2 participants
@robinraju @eloots