-
Notifications
You must be signed in to change notification settings - Fork 0
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
Beginnings of user documentation #4
Conversation
Great job on this so far, Roni. Thanks for all your hard work to get it to this point |
Co-Authored-By: Jack Wilburn <jackwilburn@tutanota.com>
Co-Authored-By: Jack Wilburn <jackwilburn@tutanota.com>
Co-Authored-By: Jack Wilburn <jackwilburn@tutanota.com>
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.
Looks good to me. I think it's still a good idea to wait for @jtomeck's approval
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.
Just took a look after building locally, looks good! Really great work.
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.
Couple notes.
Server
- You don't need to run
pipenv shell
. You can just runpipenv run serve
outside of the env and it works (for me, at least on mac) - Can you add running
docker-compose up
on mac? I still have to useARANGO_DATA=~/.local/multinet/arango docker-compose up
Client
I'm sure you know this, and there's probably a reason you have it split into 2 steps, but I usually combine 3 & 4 and run yarn && yarn serve
to make sure I'm always up to date every time I serve.
EDIT: The only necessary change that I see is adding instructions for Mac above.
This is definitely true, but I don't see
Thanks for catching this. See 62d4aa7.
I guess I'm just being explicit about what the steps are. Doing it your way makes sure you're never out of date, but it causes the command to run a little longer. Not a big deal but I'm keeping it simple for the documentation. |
Here's an initial stab at user docs. The bulk of what I've added here (in
multinet.rst
) is a "tutorial" (using the two-axis model from that great talk on documentation), but I think that's where we want to start. I have plans to add a "reference" version of this tutorial, and then we will slowly need to add developer documentation too, but I see that as less urgent right now.You can see the docs built from this branch here: https://multinet-app.readthedocs.io/en/user-docs/
Let me know what you think. @jtomeck, I'm especially interested in your opinion since you design for this project a lot, but don't necessarily test it out with actual use cases as often as the rest of us.
Closes multinet-app/multinet-client#10