AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

Documentation re-organization

Open
#112 1 comment 1 reaction 1 assignee Assigned to @Xazin View on GitHub
documentation
Dominant language
No language data
Stars
109
Forks
108
PR merge metrics
No merged PRs in 30d

Description

Create a better structure to make the documentation more intuitive to navigate and easier to contribute
The documentation should include:
- User Manual: how to install, how to use, best practices, etc @Xazin
- Developer Docs: how to install from source, how to contribute, architect design, how to xxx, etc @LucasXu0
- Community Docs: programs, mentorship projects, community themes and plugins @richardshiue
- Organization Docs: values, roadmaps @annieappflowy

Steps:
- [ ] Create outlines (parent nodes and subpages under)
- [ ] Re-organize the current pages based on the new outlines
- [ ] Add missing resources
- [ ] Team members should be responsible for writing product manuals for the features they built and to be built
- [ ] Send out a survey to the community for feedback and calculate the base rating for future iterations

High priority:
- [ ] Write a doc on how to self-host AppFlowy @speed2exe
- [ ] How to use TestFlight to test AppFlowy Cloud @LucasXu0

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.