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

Add documentation #5

Open
2 tasks
visualcookie opened this issue Sep 12, 2020 · 5 comments · May be fixed by #18
Open
2 tasks

Add documentation #5

visualcookie opened this issue Sep 12, 2020 · 5 comments · May be fixed by #18
Assignees
@visualcookie
Labels
documentation Improvements or additions to documentation
Projects
v1.0.0

Comments

@visualcookie
Copy link
Contributor

Motivation

Right now to document the structure and motivation behind it, the README.md files are in seperate folders. To emit having a bloated README.md file in our projects, we should move further documentation to the Wiki.

Tasks

  • Setup structure for Wiki pages
  • Add content
@visualcookie visualcookie added the documentation Improvements or additions to documentation label Sep 12, 2020
@visualcookie visualcookie self-assigned this Sep 12, 2020
@visualcookie visualcookie added this to To do in v1.0.0 via automation Sep 12, 2020
@visualcookie
Copy link
Contributor Author

Alternatively have a /docs folder instead of GitHub Wiki.

@iduuck
Copy link
Member

iduuck commented Sep 26, 2020

Let's go with Docusaurus 2. I think it is the perfect fit for us to describe and document the boilerplate for us and the public.

@iduuck iduuck linked a pull request Sep 28, 2020 that will close this issue
Draft
@iduuck iduuck moved this from To do to In progress in v1.0.0 Sep 28, 2020
@visualcookie visualcookie mentioned this issue Sep 29, 2020
Closed
@visualcookie visualcookie changed the title Move README files to Wiki Add documentation Sep 29, 2020
@visualcookie
Copy link
Contributor Author

visualcookie commented Sep 29, 2020 •
edited

Structure

TOC

  • Motivation
  • File Structure
  • Advanced (i18n, tests, ...)

@iduuck
Copy link
Member

iduuck commented Sep 30, 2020

@visualcookie I already set up a basic structure, please see the branch for documentation.

@visualcookie
Copy link
Contributor Author

@visualcookie I already set up a basic structure, please see the branch for documentation.

Yeah, I was not done with the TOC yet. I wanted to basically ad the TOC to this issue, so we know what we have to add to the docs.

@visualcookie visualcookie mentioned this issue Sep 30, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@visualcookie visualcookie

Labels
documentation Improvements or additions to documentation
Projects
v1.0.0
  
In progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docusaurus docs implementation fintory/boot-next
2 participants
@iduuck @visualcookie