-
Notifications
You must be signed in to change notification settings - Fork 4
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
docs: Add installation guide to mkdocs #1053
Conversation
Would it until it is merged with the readme be beneficial to add a hint in the readme to read the user docs for installation setup purposes? Maybe one sentence is enough but will make it a lot more discoverable |
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1053 +/- ##
=======================================
Coverage 71.06% 71.06%
=======================================
Files 155 155
Lines 4869 4869
Branches 522 522
=======================================
Hits 3460 3460
Misses 1312 1312
Partials 97 97 ☔ View full report in Codecov by Sentry. |
493b08f
to
8e66cc5
Compare
Done. I just removed the whole "production" installation instructions from the README. Also added TeamForCapella client installation instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just read it and did not try it out so can not say whether I as a user would miss a step but I think it is really useful and very detailed 👍 Good docs
249e781
to
a270163
Compare
There is also a less detailed installation guide in the README. These instructions should be merged in a later PR.
The resource section was added to the user documentation. The installation part of the README was moved to the user docs.
...to the installation guide.
a270163
to
2dda1d4
Compare
There is also a less detailed installation guide in the README. These instructions should be merged in a later PR.