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.

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

Documentation re-organization #112

Open
6 tasks
annieappflowy opened this issue Aug 7, 2023 · 1 comment
Open
6 tasks

Documentation re-organization #112

annieappflowy opened this issue Aug 7, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@annieappflowy
Copy link
Collaborator

annieappflowy commented Aug 7, 2023

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
@annieappflowy annieappflowy added the documentation Improvements or additions to documentation label Aug 7, 2023
@Xazin
Copy link
Collaborator

Xazin commented Sep 21, 2023

For this step Add missing resources - We need to identify which are important to document, and which are low-priority or irrelevant.

This will become easier to identify once we have done the first, second, and fourth steps. Thus making this the final step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In progress
Development

No branches or pull requests

2 participants