Our documentation at https://docs.btcpayserver.org/Walkthrough is slightly outdated.
The goal of that page is to walk users through each item in the sidebar in the order it appears, give a short explanation of what it does, and link to a dedicated page where they can learn more about that feature.
Here’s the proposed approach for refactoring this page:
- Set up a local BTCPay Server instance if you do not already have access to a server with admin permissions. This is important because some sidebar features are only visible to admins. We should also highlight this in the documentation, since most users likely will not have admin access when they first get started.
- Briefly explain each sidebar feature in the order it appears in the UI.
- Pay special attention to plugins and terminology cleanup. We no longer use both “apps” and “plugins” in the UI. Everything is now referred to as plugins. This section should focus on explaining the default plugins and letting users know that many more plugins are available, which admins can install or regular users can ask their server admin to enable: https://plugin-builder.btcpayserver.org/public/plugins/
- Optional, but ideal: re-record the walkthrough video so it is up to date. The current video is helpful, but outdated.
If you’d like to work on this refactor, leave a comment and I’ll assign it to you. If anything is unclear, feel free to ask questions.
Our documentation at https://docs.btcpayserver.org/Walkthrough is slightly outdated.
The goal of that page is to walk users through each item in the sidebar in the order it appears, give a short explanation of what it does, and link to a dedicated page where they can learn more about that feature.
Here’s the proposed approach for refactoring this page:
If you’d like to work on this refactor, leave a comment and I’ll assign it to you. If anything is unclear, feel free to ask questions.