Coder Social home page Coder Social logo

appflowy-docs's People

Contributors

a-wallen avatar aarhusgregersen avatar abubakrchan avatar amannegi avatar annieappflowy avatar appflowy avatar bionicbug avatar egp415 avatar fangykai avatar impranshu avatar jpenna avatar jrs296 avatar lucasxu0 avatar mayursmahajan avatar mikewallacedev avatar narcos101 avatar naumansajjad avatar pablocastellano avatar peter-gy avatar polypixeldev avatar prajwal27 avatar prashant235913 avatar richardshiue avatar shan-shaji avatar smartmind12 avatar speed2exe avatar vallezw avatar vedon avatar xazin avatar zoli avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

appflowy-docs's Issues

[Fix] How to Contribute to Appflowy

Regarding few requested changes that need to be fixed:

  • Title Case - use: https://capitalizemytitle.com/
  • Line 47, shorten it
  • Line 123, shorten it
  • Line 78
  • Line 149
  • General tone improvement + making text more concise where required
  • General Grammar check
  • Improving image resolution on Appflowy Docs?

[Write for AppFlowy] How To's: How to add new property to appflowy database

Will discuss how appflowy database overally works, some insights on how it's possible introuducing new property, group by, filtering and filter options. Plus a more detailed guide to how add new property to appflowy database with updated at and created at property as an example.

1 - AppFlowy Database
general explanation that flowy database is behind Appflowy grid, board, calendar view.
1.1 - Entities
1.1.1 - Cell
1.1.2 - Field
1.1.3 - Row
1.1.4 - Sort
1.1.5 - Filter
1.1.5.1 - Where to start with adding new filter condition
1.1.6 - Group
1.1.6.1 - Where to start with adding new group by
1.2 - Services
1.3 - Events

2 - How to add new property
2.1 - Lets create new property "Created At" and "Updated At"
2.1.1 - Adding the new field type
2.1.2 - Hooking into events

[fix] Update Flutter Version present in Docs

Bug Description

In Flutter Setup, the wrong Flutter version is being used in the code snippet provided, as mentioned it would be nice to upgrade it to 3.7.9.

How to Reproduce

Simply follow this link. Under Step 2 you will find the following snippet:

git clone https://github.com/flutter/flutter.git --branch 3.3.10
cd flutter
echo -e "\nexport PATH=\$PATH:"`pwd`"/bin" >> ~/.bashrc
source ~/.bashrc
flutter
cd ..

Expected Behavior

We should update the Flutter Version like it is updated in the rest of the page.

Operating System

Windows 10

AppFlowy Version(s)

0.1.2

Screenshots

image

[Write for AppFlowy] Use-Case : High School Students

In this article I would demonstrate use of AppFlowy to benefit students in organizing their tasks and assignments with better productivity.

Introduction:

  • Introduce AppFlowy as a powerful tool for high school students
  • Explain how it can help students stay organized and productive

Getting Started:

  • Demonstrate how to sign up for AppFlowy and create workspaces for High School Notebooks or Subject Majors
  • Explain how to create categories, such as Notes, Assignments, Project Planning, and Daily Tasks

Creating a Timeline:

  • Discuss how to create a to-do list for assignments and tasks
  • Categorize tasks by subject or due date
  • Use tags to label important tasks and assignments

Workspace for Major Subjects:

  • Demonstrate how to make a new workspace for subject majors
  • Set up and use different categories for Notes, Quizzes, and Assignments

Assignments:

  • Show how to use AppFlowy to perform assignments and keep track of your work
  • Create research notes to help with writing assignments

Project Work:

  • Demonstrate how to use AppFlowy to plan high school projects
  • Create lists, notes, and use tagging features to keep track of project requirements, goals, milestones, and deadlines

Collaboration:

  • Show how to use AppFlowy to collaborate with research members
  • Share notes, lists, and effectively coordinate research work and project plans
  • Coordinate project progress

Conclusion:

  • Summarize the benefits of using AppFlowy for high school students
  • Explain how to maximize productivity using AppFlowy
  • Encourage students to try AppFlowy and experience the benefits of better productivity.

Target Audience: High School Students

No links to documentation

Whether in the README.md or in About section , I can't see the link to the docs
Only explanation is there

Can I contribute to add that in the README.md , if yeah , please assign me this

[Write for AppFlowy] How To's: How to Contribute to Appflowy

How to make coding contributions to appflowy
2.1 How to connect with the team.
2.2 How to identify and solve your first PR.
2.3 How to propose new features for Appflowy (via GitHub Issues)
2.4 An Example on how to handle your first PR, including documentation standards used, as well as good code practices.

How to best engage with the community
3.1 General guidelines on the community, and how to approach contributions with the help of the community.

Links to Resources to help get started with technical contributions:
5.1 Flutter
5.2 Rust
5.3 Git & GitHub + Working via GitHub Flows

Other Initiatives:
6.1 Appflowy Mentorship Program (Link to How-To's for Appflowy Mentorship Program if blog post has been made)

Conclusion
7.1 General Summary/Conclusion.

[Write for AppFlowy] Use-case: Software Engineer

In this article, I will show you how I use Appflowy as a Software Engineer.

Here is outline for this use case:

Introduction:
1.1. Purpose of article.
1.2. Benefits of using Appflowy as a Software Engineer

2.Setting Up:
2.1. Explain how to create a workspace in AppFlowy for your software engineering projects.
2.2. Describe the different categories you might want to create, such as Project Planning, Development Tasks, Bugs and Issues, and Project Completion.

Project Planning:
3.1. Describe how to use AppFlowy to plan your software engineering projects.
3.2. Explain how to create lists and use notes and tagging to keep track of things like project goals, requirements, milestones, and deadlines.

Development Tasks:
4.1. Explain how to use AppFlowy to manage your software development tasks.

Bugs and Issues:
5.1. Describe how to use AppFlowy to track software bugs and issues.
5.2. Explain how to create lists and use notes and tagging features to keep track of things like bug reports, issue tracking etc.

Project Completion:
6.1. Explain how to use AppFlowy to manage the completion of your software engineering projects.
6.2. Describe how to create lists and use notes and tagging features to keep track of project.

Collaboration:
7.1. Explain how to use AppFlowy to collaborate with project team members.
7.2. Describe how to share lists, effectively communicate with team members and coordinate project plans and progress.

Conclusion:
8.1. Summarize the benefits of using AppFlowy for software engineering and how a Software Engineer maximize productivity using Appflowy:)

Our target audience will be the whole community of Software developers/Engineers.

Fix: The AppFlowy logo at top bar reduces readability in light mode

Issue

As shown in the video below the black text does not go well with the background color of the top bar. Here are the options I would suggest:

  1. Only use the logo with white text across dark and light mode.
  2. Change the top bar background color to some light shade.

Before

Screenshot from 2023-08-25 21-40-53

After

Screenshot from 2023-08-25 21-37-13

The logo now looks readable, and goes well with the background.

Typo on flutter/codemap

Reference to the Documentation page : ref

The flutter working directory is appflowy_flutter, but in documentation, it is mentioned: app_flowy

[Contribute to AppFlowy] Unit Test: How to Write a Test

The part related to writing test needs some more documentation. As a newcomer, I feel the part related to writing test is really important to get started to contribute to AppFlowy. It could help us completing the checklist when submiting the first pr as well as speeding up the process to get familiar with the codebase. In addition, it can also help to increase the test coverage if more people are able to start with writing some testcases as a way to start contributing to AppFlowy.

Screen Shot 2023-05-21 at 10 44 20

Unraid install

Someone tried to install on Unraid? Successfully? I ran into an error
рпрпарапрапрапр

[Doc] Proposal for Relicensing AppFlowy Docs from AGPL to CC-BY-SA

According to our legal consultant, CC-BY or CC-BY-SA is more suitable for documentation. We decide to relicense AppFlowy Docs from AGPL 3.0 to CC-BY-SA. The timeline for re-licensing:

  • May 1st: All future contributions to https://github.com/AppFlowy-IO/AppFlowy-Docs will be under CC-BY-SA
  • May 2nd: Seek consent from past contributors to this repo who have not signed a CLA with us
  • May 31: Begin removing or rewriting documentation that cannot be relicensed

The purpose of this post is to create transparency into this upcoming change and open up discussions in the community.

Comparative Rich-Text Editor Review : appflowy_editor, flutter_quill, and super_editor

  • Introduction :

    • What is Rich-Text Editor :
  • Appflowy_Editor :

    • Data Structure :

    • Extensibility :

    • Test Coverage :

    • Documentation :

    • Privacy :

    • Community Support :

    • Pros :

    • Cons :

  • Flutter_Quill :

    • Data Structure :

    • Extensibility :

    • Test Coverage :

    • Documentation :

    • Privacy :

    • Community Support :

    • Pros :

    • Cons :

  • Super_Editor :

    • Data Structure :

    • Extensibility :

    • Test Coverage :

    • Documentation :

    • Privacy :

    • Community Support :

    • Pros :

    • Cons :

Documentation re-organization

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

Architecture tab of documentation needs some links under it

I think it will be more clear if you can add some link under the documentation for architecture. Currently it looks like this:
Screen Shot 2023-05-21 at 01 04 39
I hope it can look like this:
Screen Shot 2023-05-21 at 01 04 48
Currently I can only find the documentation under the sidebar of architecture.

Missing Directory/Component in folder hierarchy of AppFlowy Flutter

The referenced directories/components in flutter/codemap are not found in the source code repository.
Link to the Documentation : ref

Despite being indicated in the folder hierarchy, the following components are absent:

  • appflowy_flutter/assets/translations
  • appflowy_flutter/packages/appflowy_board
  • appflowy_flutter/packages/appflowy_editor
  • rust-lib/dart-notify
  • rust-lib/flowy-grid

macOS system requirements update

I know it can't be 10.14.6 Mojova as the app instantly crashes on launch (that's fine by the way, I didn't expect it to work,

[FR]Tutorial Section

I believe having a tutorial section or guide section can help new contributors find their way around AppFlowy components and its structure.
For example having a section for Frontend can help contributors who mainly want to deal with Flutter only.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.