Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeDoctorDE committed Nov 1, 2024
1 parent a9fdeeb commit da59e1f
Show file tree
Hide file tree
Showing 21 changed files with 164 additions and 55 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ jobs:
chmod 600 sftp_key
echo "$SFTP_KNOWN_HOSTS" > known_hosts
chmod 600 known_hosts
rsync -avz --delete -e "ssh -i sftp_key -o UserKnownHostsFile=known_hosts" build/web/ $SFTP_USERNAME@$SFTP_HOST:/var/www/$WEB_DIR.butterfly.linwood
rsync -avz --delete -e "ssh -i sftp_key -o UserKnownHostsFile=known_hosts" build/web/ $SFTP_USERNAME@$SFTP_HOST:/var/www/$WEB_DIR.flow.linwood
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ If you have any questions, please contact me at [[email protected]](mailto:con

There is a matrix server for this project [here](https://linwood.dev/matrix) and a discord server [here](https://discord.linwood.dev).

Please follow the [Code of Conduct](https://docs.butterfly.linwood.dev/code-of-conduct).
Please follow the [Code of Conduct](https://flow.linwood.dev/code-of-conduct).

## Give feedback

The best way to give feedback is to open an issue on GitHub.
Please report any bug you find [here](https://github.com/LinwoodDev/Butterfly/issues/new?assignees=CodeDoctorDE&labels=bug%2Ctriage&template=bug_report.yml&title=%5BBug%5D%3A+).
Please report any bug you find [here](https://github.com/LinwoodDev/Flow/issues/new?assignees=CodeDoctorDE&labels=bug%2Ctriage&template=bug_report.yml&title=%5BBug%5D%3A+).

If you have a feature that you would like to see added, please open an issue [here](https://github.com/LinwoodDev/Butterfly/issues/new?assignees=CodeDoctorDE&labels=enhancement%2Ctriage&template=feature_request.yml&title=%5BFeature+request%5D%3A+).
If you have a feature that you would like to see added, please open an issue [here](https://github.com/LinwoodDev/Flow/issues/new?assignees=CodeDoctorDE&labels=enhancement%2Ctriage&template=feature_request.yml&title=%5BFeature+request%5D%3A+).

## Test nightly builds

Nightly builds are not production ready and need to be tested.
Please report any bugs in the github issues section.

Read more about it [here](https://docs.butterfly.linwood.dev/nightly).
Read more about it [here](https://flow.linwood.dev/nightly).

## Write documentation

Expand All @@ -44,7 +44,7 @@ Fork the project and create a pull request to add your documentation to the `dev
## Translate

Crowdin is a service that allows you to translate the documentation and the app.
Click [here](https://translate.linwood.dev/butterfly) to see the project and start translating.
Click [here](https://translate.linwood.dev/flow) to see the project and start translating.
If you have a new language to add, please contact me.

## Code
Expand Down
19 changes: 0 additions & 19 deletions app/build.sh

This file was deleted.

4 changes: 0 additions & 4 deletions app/screenshot.bat

This file was deleted.

4 changes: 0 additions & 4 deletions app/screenshot.sh

This file was deleted.

9 changes: 0 additions & 9 deletions app/vercel.json

This file was deleted.

18 changes: 7 additions & 11 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
commit_message: '[ci skip]'
commit_message: "[ci skip]"
files:
- source: /app/lib/l10n/app_en.arb
translation: /app/lib/l10n/app_%osx_locale%.arb
- source: /docs/i18n/en/**/*
translation: /docs/i18n/%two_letters_code%/**/%original_file_name%
- source: /docs/docs/**/*
translation: /docs/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%
- source: /docs/community/**/*
- source: /docs/src/translations/en.json
translation: /docs/src/translations/%two_letters_code%.json
- source: /docs/src/content/docs/**/*
ignore_settings: 1
ignore:
- CHANGELOG.md
- versions.md
translation: /docs/i18n/%two_letters_code%/docusaurus-plugin-content-docs-community/current/**/%original_file_name%
- source: /docs/versioned_docs/**/*
translation: /docs/i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
- "%two_letters_code%/**/*"
translation: /docs/src/content/docs/%two_letters_code%/**/%original_file_name%
Binary file added docs/src/assets/img/smart-screen-more-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/img/smart-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions docs/src/content/docs/community/branding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Branding
---

These assets are licensed under the [CC-BY-SA-4.0](https://github.com/LinwoodDev/Flow/blob/develop/BRANDING_LICENSE).

## Logo

![Logo](/img/logo.svg)

[SVG](/img/logo.svg) [PNG](/img/logo.png)

## Banner

![Banner](/img/banner.svg)

[SVG](/img/banner.svg) [PNG](/img/banner.png)

## Documentation

![Documentation](/img/docs.svg)

[SVG](/img/docs.svg) [PNG](/img/docs.png)

## Colors

* Primary: `#c4840d`
* Accent: `#7b8f96`

## Fonts

* Website: `Barlow`
* App: `Comfortaa`

## Screenshots

> Used in the firefox responsive design mode
* Phone: Galaxy S20 Ultra
* 7-inch tablet: Nexus 7
* 10-inch tablet: Nexus 10
11 changes: 11 additions & 0 deletions docs/src/content/docs/community/code-of-conduct.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: ""
head:
- tag: title
content: Code of Conduct | Linwood Flow
tableOfContents: false
---

import CodeOfConduct from "/../CODE_OF_CONDUCT.md"

<CodeOfConduct />
11 changes: 11 additions & 0 deletions docs/src/content/docs/community/contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: ""
head:
- tag: title
content: Contributing | Linwood Flow
tableOfContents: false
---

import Contributing from "/../CONTRIBUTING.md"

<Contributing />
26 changes: 26 additions & 0 deletions docs/src/content/docs/community/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Frequently Asked Questions
---

Here are some frequently asked questions.

## Web

### How do I install the web version?

You can install the web version by clicking on the install button in the title bar.
After that you can use this app offline.

### Flow does not load on Brave

Brave Users who have set the 'Block Fingerprinting' Shield setting to Aggressive, need to change it to 'Standard' or just plain 'Block Fingerprinting'.
Click on the shield icon in the address bar to change the setting.
Try updating your browser to the latest version.

## Mobile

### iOS support

> [#244](https://github.com/LinwoodDev/Butterfly/issues/244)
Flow is available on iOS as preview. Click [here](https://flow.linwood.dev/downloads/ios) to download it. See [here](https://github.com/LinwoodDev/Flow/issues/244#issuecomment-1935460878) why it's not available on the App Store.
22 changes: 22 additions & 0 deletions docs/src/content/docs/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Community
---

Welcome to the community section.

## Acknowledgements

A special thanks goes to:

* [Flutter](https://github.com/flutter/flutter) for providing this useful crossplatform ui framework
* [window_manager](https://github.com/leanflutter/window_manager) for all this useful desktop window features
* [Starlight](https://github.com/withastro/starlight) for an easy-to-use static react documentation framework
* [Phosphor Icons](https://phosphoricons.com/) for the beautiful icons

All other licenses can you found in the settings.

## Useful links

* [GitHub](https://github.com/LinwoodDev/Flow)
* [Discord](https://go.linwood.dev/discord)
* [Matrix](https://go.linwood.dev/matrix)
23 changes: 23 additions & 0 deletions docs/src/content/docs/community/nightly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Nightly Builds
---

:::warning

Do not use the nightly version of Flow for production.

:::

Nightly builds are designed to give you the option to test the latest version and get the newest features
and give feedback.

## Get the builds

Go to the download pages of your platform.
All nightly builds get also published as pre-release on github.

## Experiments

Experiments are features that are not ready for production yet.
Default they are disabled. You can enable them in the settings under `Experiments`.
This tab is only visible in the nightly version.
11 changes: 11 additions & 0 deletions docs/src/content/docs/community/versions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: ""
head:
- tag: title
content: Versions | Linwood Flow
tableOfContents: false
---

import Security from "/../SECURITY.md"

<Security />
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 0 additions & 2 deletions metadata/en-US/changelogs/7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
* Add high contrast mode
* Add classic theme
* Add notebooks
* Add right click menus
* Allow changing group and place in event creation dialog
* Make dashboard the back page
* Improve icon style for different calendar item types
Expand All @@ -17,7 +16,6 @@
* Fix week system in calendar week view
* Fix switching from moment to appointment doesn't update the dialog
* Fix list view has duplicated items
* Upgrade project layout
* Upgrade to flutter 3.19 and 3.22

Read more here: https://linwood.dev/flow/0.3
6 changes: 6 additions & 0 deletions metadata/en-US/changelogs/8.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* Add right click menus
* Fix month view start of the week
* Upgrade project layout
* Upgrade to flutter 3.24

Read more here: https://linwood.dev/flow/0.3.1

0 comments on commit da59e1f

Please sign in to comment.