Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enh(README) New screenshots, setup/troubleshooting instructions #538

Merged
merged 1 commit into from
Jan 2, 2024

Conversation

joshtrichards
Copy link
Member

@joshtrichards joshtrichards commented Dec 29, 2023

  • Adds/updates screenshots
  • Adds basic Installation instructions
  • Adds basic Configuration instructions
    • Add red Caution warning about importance and inability to recover mnemonic/encryption passphrase
  • Adds basic Usage instructions
  • Adds basic Troubleshooting notes

Still missing (but also unnecessary for this PR):

  • iOS client screenshot (not critical since this is the server component but noting since I didn't intentionally exclude it and in case someone wishes to add one as a follow-on)

Possible future follow-ups:

  • Links to the client repositories (for looking up or reporting issues, for checking release notes for fixes/enhancements)
  • Tips for commonly reported problems in this or the client repositories (FAQs or, in some cases, "known issues")
  • Tips/acknowledgements of some of the more commonly reported historical issues that are no longer considered "known issues" since they are believed to be resolved
  • Fix Security Policy link (currently goes nowhere for some reason)
  • Usage/Troubleshooting instructions:
    • Changing mnemonics
    • Resetting mnemonics
  • Add info how to build the app #340

Note: Not necessarily all of the above belong here, but noting for future ideas.

@joshtrichards joshtrichards added 3. to review Waiting for reviews enhancement New feature or request labels Dec 29, 2023
@juliusknorr juliusknorr merged commit 3db9f95 into master Jan 2, 2024
16 checks passed
@juliusknorr juliusknorr deleted the enh/readme/screenshots-instructions branch January 2, 2024 14:56
Copy link
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review Waiting for reviews enhancement New feature or request feedback-requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants