5
0
mirror of https://github.com/wailsapp/wails.git synced 2025-05-06 04:51:13 +08:00

Update docs

This commit is contained in:
Lea Anthony 2023-09-02 15:12:35 +10:00
parent 2384ae0819
commit eb5aff755f
No known key found for this signature in database
GPG Key ID: 33DAF7BB90A58405
5 changed files with 75 additions and 2 deletions

View File

@ -0,0 +1,31 @@
# Changelog
<!--
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
-->
## [Unreleased]
### Fixed
### Added
### Changed
### Removed
### Deprecated
### Security

View File

@ -0,0 +1,35 @@
# Feedback
We welcome (and encourage) your feedback! Here are the different ways to provide feedback:
=== "Bugs"
If you find a bug, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel on Discord:
- The post should clearly state what the bug is and have a simple reproducible example. If the docs are unclear what *should* happen, please include that in the post.
- The post should be given the `Bug` tag.
- Please include the output of `wails doctor` in your post.
- *Remember* unexpected behaviour isn't necessarily a bug - it might just not do what you expect it to do. Use [Suggestions](#suggestions) for this.
=== "Fixes"
If you have a fix for a bug or an update for documentation, please do the following:
- Open a pull request on the [Wails repository](https://github.com/wailsapp/wails). The title of the PR should start with `[v3]`.
- Create a post in the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel.
- The post should be given the `PR` tag.
- Please include a link to the PR in your post.
=== "Suggestions"
If you have a suggestion, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/3mgVyGua) channel on Discord:
- The post should be given the `Suggestion` tag.
Please feel free to reach out to us on [Discord](https://discord.gg/3mgVyGua) if you have any questions.
=== "Upvoting"
- Posts can be "upvoted" by using the :thumbsup: emoji. Please apply to any posts that are a priority for you.
- Please *don't* just add comments like "+1" or "me too".
- Please feel free to comment if there is more to add to the post, such as "this bug also affect ARM builds" or "Another option would be to ....."

View File

@ -5,8 +5,9 @@
--md-primary-fg-color--dark: #90030C;
--md-accent-fg-color: #ff4646;
--md-primary-fg-color: #2a2a2a;
--md-default-bg-color: #232323;
--md-default-bg-color: #191919;
--md-footer-bg-color--dark: #2a2a2a;
--md-default-fg-color: #cccccc;
}
.md-header__button.md-logo img, .md-header__button.md-logo svg {

View File

@ -69,8 +69,11 @@ nav:
# - Angular: guides/angular.md
# - Showcase:
# - Emaillit: community/showcase/emailit.md
- Contributing: community/contributing.md
# - Contributing: community/contributing.md
# - Links: community/links.md
- Feedback: getting-started/feedback.md
- Change Log: changelog.md
markdown_extensions:
- pymdownx.tabbed:

View File

@ -72,6 +72,9 @@
This is the Wails v3 Alpha website.
This site will be updated as we progress through the alpha and beta releases.<br/><br/>
v3 is a work in progress. Expect things to fail. Expect things to change.<br/><br/>
Please feel free to raise PRs against this website. Every single PR helps us get closer to a release.<br/><br/>
Thank you for sharing this journey with us.<br/><br/>
<br/>