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

README update #80

Merged
merged 3 commits into from
Apr 4, 2024
Merged

README update #80

merged 3 commits into from
Apr 4, 2024

Conversation

CJ-Rose
Copy link
Member

@CJ-Rose CJ-Rose commented Apr 1, 2024

  • remove unused, add new tech and its role to stack section
  • edit copy, add links to IPFS and ERC-1155 in 'Data Models' section
  • re-organize 'Getting Started' section to include instructions to run locally
  • update 'Prerequisites' for Next and Sepolia network config
  • add introductory info and docs links for all tech to 'Helpful References'

Copy link

netlify bot commented Apr 1, 2024

Deploy Preview for voicedeck ready!

Name Link
🔨 Latest commit 1f6adb6
🔍 Latest deploy log https://app.netlify.com/sites/voicedeck/deploys/660b45eaad598c000887a5a3
😎 Deploy Preview https://deploy-preview-80--voicedeck.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@CJ-Rose
Copy link
Member Author

CJ-Rose commented Apr 1, 2024

I've added intro descriptions of all the tools used in the repo, thinking it would be helpful for incoming contributors (including less-technical) to get an overview of all the moving parts. Might be too much, idk, what does everyone think?

'Server Design' section needs to be fleshed out more.. currently only fetchReports function is discussed. @baumstern can you add some content? I'm not sure which parts of Hypercert implementation are the most relevant to document here.

Would 'Data Models' section be a good place to add a few more definitions of concepts, like 'Impact Funding', 'BC ratio'? or better to leave those to the FAQ page?

@CJ-Rose CJ-Rose requested review from thebeyondr and baumstern April 1, 2024 23:48
Copy link
Member

@thebeyondr thebeyondr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets strip this back to get a dev up and running so they can read the code for themselves. I think there's a lot of stuff that helpful in here though, thank you!

@baumstern
Copy link
Contributor

Thanks for the update! Feel free to remove whole # Server Design section from README.md. It was intended to inform between us. IMO, README.md should give compact overview and any other details could belongs to separate pages, if needed

@CJ-Rose CJ-Rose requested a review from thebeyondr April 4, 2024 02:31
@thebeyondr thebeyondr changed the base branch from main to dev April 4, 2024 20:24
Copy link

netlify bot commented Apr 4, 2024

Deploy Preview for vd-dev ready!

Name Link
🔨 Latest commit f88d780
🔍 Latest deploy log https://app.netlify.com/sites/vd-dev/deploys/660f0c7ac0c1440008d846d7
😎 Deploy Preview https://deploy-preview-80--vd-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@thebeyondr thebeyondr merged commit 0b0e896 into dev Apr 4, 2024
6 of 7 checks passed
@thebeyondr thebeyondr deleted the README-update branch April 4, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants