trent_larson/crowd-funder-for-time-pwa
4
1
Fork 2
Code Issues Pull Requests 23 Releases 5 Wiki Activity

docs: basic pandoc setup #118

Merged
kentbull merged 4 commits from kentbull/crowd-funder-for-time-pwa:kb/add-usage-guide into master 2024-07-19 16:47:18 +00:00
Conversation 9 Commits 4 Files Changed 18
+382
kentbull commented 2024-06-25 15:27:25 +00:00
Collaborator
Copy Link
Copy Source

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.

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.
kentbull added 1 commit 2024-06-25 15:27:25 +00:00
docs: basic pandoc setup 316e4be25a
trentlarson commented 2024-06-25 17:56:32 +00:00
Owner
Copy Link
Copy Source

Love it.

Already told Kent about these other docs, which we'll work to make consistent as this is fleshed out:

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/
trentlarson commented 2024-06-25 17:57:07 +00:00
Owner
Copy Link
Copy Source

I assume this is a work in progress, seeing how the doc is just a start. LMK if you want an approval to merge.

I assume this is a work in progress, seeing how the doc is just a start. LMK if you want an approval to merge.
trentlarson commented 2024-06-25 17:57:38 +00:00
Owner
Copy Link
Copy Source

Heh... nevermind: I don't see approvals on this screen. :-)

Heh... nevermind: I don't see approvals on this screen. :-)
kentbull commented 2024-06-25 19:31:15 +00:00
Author
Collaborator
Copy Link
Copy Source

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.

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.
kentbull commented 2024-06-25 21:05:14 +00:00
Author
Collaborator
Copy Link
Copy Source

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.

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.
kentbull added 1 commit 2024-06-26 01:30:30 +00:00
docs: add more docs on local run 38ec7320bb
kentbull force-pushed kb/add-usage-guide from a2692b2b4e to 23cc923144 2024-06-26 17:06:18 +00:00 Compare
kentbull added 1 commit 2024-06-26 17:20:00 +00:00
Merge branch 'master' into kb/add-usage-guide 2a8aa8be78
kentbull commented 2024-06-26 17:46:55 +00:00
Author
Collaborator
Copy Link
Copy Source

This is now ready to be merged.

This is now ready to be merged.
trentlarson commented 2024-06-27 02:28:07 +00:00
Owner
Copy Link
Copy Source

👍

I just added you as a collaborator, so you should be able to merge this.

👍 I just added you as a collaborator, so you should be able to merge this.
trentlarson commented 2024-06-27 02:28:41 +00:00
Owner
Copy Link
Copy Source

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.

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.
trentlarson commented 2024-06-29 19:59:17 +00:00
Owner
Copy Link
Copy Source

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.

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.
kentbull merged commit 1172aad318 into master 2024-07-19 16:47:18 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
anomalist jose (Jose Olarte 3) jsnbuchanan kentbull (Kent Bull) trentlarson
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: trent_larson/crowd-funder-for-time-pwa#118