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

Merge /docs and /documentation #1386

Closed
2 tasks done
connormullett opened this issue Jan 17, 2022 · 0 comments · Fixed by #1390
Closed
2 tasks done

Merge /docs and /documentation #1386

connormullett opened this issue Jan 17, 2022 · 0 comments · Fixed by #1390
Assignees
@connormullett
Labels
Status: Needs Triage Issue has unresolved discussions and/or needs to be assigned a priority and assignee

Comments

@connormullett
Copy link
Contributor

connormullett commented Jan 17, 2022 •
edited
Loading

Issue summary

Two different directories exist for documentation. /docs is for general codebase knowledge and script usage, and /documentation is for generated user facing documentation. These should be merged into one directory. The existing items
in /docs should not be generated by mdbook. Functionality should remain the same.

Acceptance Criteria

  • Mdbook generated docs remain the same and do not serve developer docs
  • Developer docs are merged into one directory with user docs
@connormullett connormullett added the Status: Needs Triage Issue has unresolved discussions and/or needs to be assigned a priority and assignee label Jan 17, 2022
@connormullett connormullett self-assigned this Jan 17, 2022
@connormullett connormullett mentioned this issue Jan 19, 2022
Merged
@q9f q9f mentioned this issue Feb 11, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@connormullett connormullett

Labels
Status: Needs Triage Issue has unresolved discussions and/or needs to be assigned a priority and assignee
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Move /docs to /documentation ChainSafe/forest
1 participant
@connormullett