-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1c1eb89
commit f7976a5
Showing
72 changed files
with
966 additions
and
305 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
v2.0.0-beta.38 | ||
v2.0.0-beta.39 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 0 additions & 9 deletions
9
website/versioned_docs/version-v2.0.0-beta.37/community/showcase/surge.mdx
This file was deleted.
Oops, something went wrong.
78 changes: 0 additions & 78 deletions
78
website/versioned_docs/version-v2.0.0-beta.37/gettingstarted/installation.mdx
This file was deleted.
Oops, something went wrong.
39 changes: 0 additions & 39 deletions
39
website/versioned_docs/version-v2.0.0-beta.37/guides/developing-wails.mdx
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions
3
...eta.37/community/showcase/encrypteasy.mdx → ...eta.39/community/showcase/encrypteasy.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
...-beta.37/community/showcase/filehound.mdx → ...-beta.39/community/showcase/filehound.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
...eta.37/community/showcase/mollywallet.mdx → ...eta.39/community/showcase/mollywallet.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
website/versioned_docs/version-v2.0.0-beta.39/community/showcase/october.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# October | ||
|
||
<p style={{"text-align": "center"}}> | ||
<img src="/img/showcase/october.png"></img><br/> | ||
</p> | ||
|
||
[October](https://october.utf9k.net) is a small Wails application that makes it really easy to extract highlights from [Kobo eReaders](https://en.wikipedia.org/wiki/Kobo_eReader) and then forward them to [Readwise](https://readwise.io). | ||
|
||
It has a relatively small scope with all platform versions weighing in under 10MB, and that's without enabling [UPX compression](https://upx.github.io/)! | ||
|
||
In contrast, the author's previous attempts with Electron quickly bloated to several hundred megabytes. |
3 changes: 1 addition & 2 deletions
3
....0-beta.37/community/showcase/optimus.mdx → ....0-beta.39/community/showcase/optimus.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
...0-beta.37/community/showcase/portfall.mdx → ...0-beta.39/community/showcase/portfall.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
...ite/versioned_docs/version-v2.0.0-beta.39/community/showcase/restic-browser.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Restic Browser | ||
|
||
<p style={{"text-align": "center"}}> | ||
<img src="/img/showcase/restic-browser-2.png"></img><br/> | ||
</p> | ||
|
||
[Restic-Browser](https://github.com/emuell/restic-browser) - A simple, cross-platform [restic](https://github.com/restic/restic) backup GUI for browsing and restoring restic repositories. | ||
|
||
|
||
|
3 changes: 1 addition & 2 deletions
3
...-beta.37/community/showcase/riftshare.mdx → ...-beta.39/community/showcase/riftshare.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
website/versioned_docs/version-v2.0.0-beta.39/community/showcase/surge.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Surge | ||
|
||
<p style={{"text-align": "center"}}> | ||
<img src="/img/showcase/surge.png"></img><br/> | ||
</p> | ||
|
||
[Surge](https://getsurge.io/) is a p2p filesharing app designed to utilize blockchain technologies to enable 100% anonymous file transfers. Surge is end-to-end encrypted, decentralized and open source. | ||
|
3 changes: 1 addition & 2 deletions
3
....0.0-beta.37/community/showcase/wally.mdx → ....0.0-beta.39/community/showcase/wally.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
...0.0-beta.37/community/showcase/wombat.mdx → ...0.0-beta.39/community/showcase/wombat.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
...v2.0.0-beta.37/community/showcase/ytd.mdx → ...v2.0.0-beta.39/community/showcase/ytd.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,7 @@ | ||
|
||
# Ytd | ||
|
||
<p> | ||
<img src="/img/showcase/ytd.png"></img><br/> | ||
<img src="/img/showcase/ytd.png"></img><br/> | ||
</p> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
website/versioned_docs/version-v2.0.0-beta.39/contributing/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Contributing", | ||
"position": 99 | ||
} |
35 changes: 35 additions & 0 deletions
35
.../versioned_docs/version-v2.0.0-beta.39/contributing/developing_new_features.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
sidebar_position: 20 | ||
--- | ||
|
||
# Developing New Features | ||
|
||
We are always keen to add features to Wails and expand on what the project can do. | ||
The process for adding new features are as follows: | ||
|
||
- Pick an enhancement ticket with the "TODO" label. It's preferable to select one from the current | ||
[Backlog](https://github.com/orgs/wailsapp/projects/1/views/1) but the choice is yours. | ||
- Before developing, check that the ticket includes the following information: | ||
- The purpose of the enhancement | ||
- What is out of scope for the enhancement | ||
- What platforms the enhancement targets (most features should be cross-platform unless there's a very specific reason) | ||
- If the ticket does not include this information, feel free to request the information from the | ||
person who opened the ticket. Sometimes placeholder tickets are created and require more details | ||
- Comment on the ticket stating you wish to develop the feature | ||
- Clone the repository and create a branch with the format `feature/<ticket_number>_<ticket_title>` | ||
- New features often require documentation so please ensure you have also added or updated the documentation as part of | ||
the changes | ||
- Once the feature is ready for testing, create a draft PR. Please ensure the PR description has the test scenarios and | ||
test cases listed with checkmarks, so that others can know what still needs to be tested. | ||
- Once all the testing is completed, please update the status of the PR from draft and leave a message. | ||
|
||
:::note | ||
There is nothing stopping you from opening a ticket and working on it yourself, but please be aware that all | ||
enhancement requests are reviewed for good fit. Not all ideas will be selected so it's best to have discussion | ||
on the ticket first. | ||
::: | ||
|
||
:::warning | ||
Any PRs opened without a corresponding ticket may be rejected. | ||
::: | ||
|
39 changes: 39 additions & 0 deletions
39
website/versioned_docs/version-v2.0.0-beta.39/contributing/documenting.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
sidebar_position: 40 | ||
--- | ||
|
||
# Documenting | ||
|
||
This website is also the main documentation site for the project. Sometimes this gets | ||
out of date and needs some slight adjustments. Some of the documentation isn't written | ||
to the best standards either. Developing documentation is hard and so any contribution | ||
to this is greatly appreciated. Features without documentation are unfinished so to the | ||
project, it's *as important* as the code. | ||
|
||
We generally do not create tickets for updating documentation so if there is text you | ||
think should be updated or rephrased then feel free to submit a PR for that. This site | ||
is in the main repository under the `website` directory. We use [Docusaurus](https://docusaurus.io/) to create | ||
the site so there is plenty of existing documentation and tutorials around to get started. | ||
|
||
To set up a local documentation development environment, do the following: | ||
|
||
- [Install npm](https://docs.npmjs.com/cli/v8/configuring-npm/install) | ||
- `cd website` | ||
- `npm install` | ||
- `npm run start` | ||
|
||
After it has all installed and is running, you should see the site at [`http://localhost:3000`](http://localhost:3000). | ||
Any changes made to the site text will be immediately reflected in the browser. | ||
|
||
## Versioning | ||
|
||
We employ a versioning system where we have the "latest" documentation AKA "Next Version" which | ||
has all the changes that have occurred since the last release. We also keep the last release | ||
documentation as well as the version before that. | ||
|
||
There isn't usually a reason to update released documentation so we don't generally update | ||
the documents in the `versioned_docs` or `versioned_sidebars` directories. | ||
|
||
The "next version" docs are mainly in `website/docs` with some "version independent" documents | ||
in `src/pages`. Any updates should be made in the `website/docs` directory. | ||
|
Oops, something went wrong.