Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

Migrate documentation to github wiki #2

Open
WillCWX opened this issue Jun 8, 2022 · 2 comments
Open

Migrate documentation to github wiki #2

WillCWX opened this issue Jun 8, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@WillCWX
Copy link
Collaborator

WillCWX commented Jun 8, 2022

We should move the documentation in the repository folder into the wiki to reduce clutter in the repo.
The wiki will also allow for greater ease of creating documentation.
@ChubbsBunns This will change the way we document overall and reduce merge conflicts due to different documentations.

@WillCWX WillCWX added the documentation Improvements or additions to documentation label Jun 8, 2022
@WillCWX WillCWX added this to the Milestone 2 milestone Jun 8, 2022
@WillCWX WillCWX self-assigned this Jun 8, 2022
@WillCWX
Copy link
Collaborator Author

WillCWX commented Jun 11, 2022

Basic documentation, like milestone 1 and project log has been moved.
However, specific documentation like style guides, and code documentations have yet to be created.

  • add Style Guide
  • add ReactJS Component Guide
  • add MongoDB Schema
  • add NodeJS and ExpressJS Server documentation

@WillCWX
Copy link
Collaborator Author

WillCWX commented Jun 29, 2022

As Milestone 2 has just passed, we have noted that more documentation may be required:

  • User Guide
  • Developer Guide

@WillCWX WillCWX modified the milestones: Milestone 2, Milestone 3 Jun 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant