CaptainFact / CaptainFact/captain-fact

Centralize all documentations on Gitbook

Open
#49 0 comments 0 reactions 1 assignee Claimed by @Betree View on GitHub
complexity > medium frontend
Dominant language
No language data
Stars
71
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Using Gitbook, we can still benefit from all the advantages of using git (Github WYSIWYG editor, versions) but also have some benefits:
- Nice UI
- Multilingual
- User feedback (good/neutral/bad)

By embedding it in Frontend with an iframe, we'll unify all documentations in the same place and we'll be able to update it without re-deploying.

# Steps

- [ ] Create Gitbook with a custom book.json
- [ ] Move all help page to repo `/docs`
- [ ] Add pages from Github Wiki
- [ ] Add multilanguage
- [ ] Embed on Frontend
- [ ] Bonus: Keep compatibility with old routes
- [ ] Update all existing routes
- [ ] Deprecate Github Wiki

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.