diff --git a/mkdocs-website/docs/changelog.md b/mkdocs-website/docs/changelog.md new file mode 100644 index 000000000..d6902ff21 --- /dev/null +++ b/mkdocs-website/docs/changelog.md @@ -0,0 +1,31 @@ +# Changelog + + + +## [Unreleased] + +### Fixed + +### Added + +### Changed + +### Removed + +### Deprecated + +### Security + diff --git a/mkdocs-website/docs/getting-started/feedback.md b/mkdocs-website/docs/getting-started/feedback.md new file mode 100644 index 000000000..657635ccc --- /dev/null +++ b/mkdocs-website/docs/getting-started/feedback.md @@ -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 ....." diff --git a/mkdocs-website/docs/stylesheets/extra.css b/mkdocs-website/docs/stylesheets/extra.css index ce27543af..296850e20 100644 --- a/mkdocs-website/docs/stylesheets/extra.css +++ b/mkdocs-website/docs/stylesheets/extra.css @@ -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 { diff --git a/mkdocs-website/mkdocs.yml b/mkdocs-website/mkdocs.yml index b3fc8be7e..44ead16e2 100644 --- a/mkdocs-website/mkdocs.yml +++ b/mkdocs-website/mkdocs.yml @@ -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: diff --git a/mkdocs-website/overrides/home.html b/mkdocs-website/overrides/home.html index 05e35ee8a..3cf46726f 100644 --- a/mkdocs-website/overrides/home.html +++ b/mkdocs-website/overrides/home.html @@ -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.

+ + v3 is a work in progress. Expect things to fail. Expect things to change.

+ Please feel free to raise PRs against this website. Every single PR helps us get closer to a release.

Thank you for sharing this journey with us.