docs: basic pandoc setup #118
Merged
kentbull
merged 4 commits from kentbull/crowd-funder-for-time-pwa:kb/add-usage-guide
into master
4 months ago
Loading…
Reference in new issue
There is no content yet.
Delete Branch 'kentbull/crowd-funder-for-time-pwa:kb/add-usage-guide'
Deleting a branch is permanent. It CANNOT be undone. Continue?
This adds a basic pandoc guide for the app. As I learn how to do different things in the app I will add them to this guide so I can keep track of them and make something other people can refer to.
A generated PDF is attached to this PR.
Love it.
Already told Kent about these other docs, which we'll work to make consistent as this is fleshed out:
in-app help https://timesafari.app/help
in-app onboarding help https://timesafari.app/help-onboarding
my overview content https://endorser.ch/doc/html/intro.html#overview
onboarding video https://www.youtube.com/watch?v=rWbrMCY-HuQ
API docs https://api.endorser.ch/api-docs/
I assume this is a work in progress, seeing how the doc is just a start. LMK if you want an approval to merge.
Heh... nevermind: I don't see approvals on this screen. :-)
yes, this is ready to merge. If you like it I wanted to get this merged in so I can come add details as I make my way through each part of the app.
Actually, leave this open until I get the developer setup guide in there for bootstraping a local setup. I'll add a bash script that does this all as well.
a2692b2b4e
to23cc923144
5 months agoThis is now ready to be merged.
👍
I just added you as a collaborator, so you should be able to merge this.
Note that there's an even easier way to onboard someone: when you add someone unregistered as a contact, it prompts you to register them.
Since this repo is focused on Time Safari, let's make the Endorser server part optional in a set of instructions. For example, the whole "Software Developers" "Prerequisites" #2 part is optional for someone who just wants to run Time Safari (because they'd use the test server, where user 0x000 is initialized). Same for "Database Creation" down to #3.
This is OK for this merge, but I think those edits would be needed before we integrate with the main README.md and other docs.
1172aad318
into master 4 months ago1172aad318
.