appflowy-io / appflowy-docs Goto Github PK
View Code? Open in Web Editor NEWLicense: Other
License: Other
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
This is part of Write for AppFlowy. Click here to see more details.
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,
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:
as described in the title
This is part of Write for AppFlowy. Click here to see more details.
This is part of Write for AppFlowy. Click here to see more details.
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
This is part of Write for AppFlowy. Click here to see more details.
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.
Create a better structure to make the documentation more intuitive to navigate and easier to contribute
The documentation should include:
Steps:
High priority:
This is part of Write for AppFlowy
. Click here to see more details.
Regarding few requested changes that need to be fixed:
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
.
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 ..
We should update the Flutter Version like it is updated in the rest of the page.
Windows 10
0.1.2
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:
The purpose of this post is to create transparency into this upcoming change and open up discussions in the community.
Introduction :
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 :
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.
The docker setup includes these two lines:
Step 3: Provide access of appflowy to X session
xhost local:root
I've set up a fair number of docker apps, and haven't seen it before, so it raises a yellow flag.
seems harmless enough in this context but some more details about why its needed will be great.
This is part of Write for AppFlowy. Click here to see more details.
In this article I would demonstrate use of AppFlowy to benefit students in organizing their tasks and assignments with better productivity.
Introduction:
Getting Started:
Creating a Timeline:
Workspace for Major Subjects:
Assignments:
Project Work:
Collaboration:
Conclusion:
Target Audience: High School Students
Your links on this page redirect to a request to sign into gitbook instead of to the subpages in the documentation:
https://appflowy.gitbook.io/docs/essential-documentation/install-appflowy/installation-methods
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:
The logo now looks readable, and goes well with the background.
This is part of Write for AppFlowy. Click here to see more details.
Reference to the Documentation page : ref
The flutter working directory is appflowy_flutter
, but in documentation, it is mentioned: app_flowy
This is part of Write for AppFlowy. Click here to see more details.
Instead it redirects to all issues, which isn't the desired solution.https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy
On clicking proposed features, i get redirected to issues without the "new feature" label. It should have the link of "new feature" label in it.
This is part of Write for AppFlowy. Click here to see more details.
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.
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.
The current Windows Environment Setup docs have
Step 3: Build AppFlowy (Flutter GUI application)
Step 4: Run the application
and the current Linux Environment Setup docs have
Step 3: Build AppFlowy (Flutter GUI application)
These steps can be removed and formatted in the way the macOS Environment Setup docs are present.
The link for How we built AppFlowy with Flutter and Rust is incorret, it links to https://github.com/AppFlowy-IO/AppFlowy. Instead, it should link to https://blog-appflowy.ghost.io/tech-design-flutter-rust/.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.