search

ourzora / zdk

MIT License
107 stars 42 forks source link

[chore] Fix broken links in docs #37

Closed alexreyes closed 3 years ago

alexreyes commented 3 years ago

On the minting page, the links to metadata and the utils docs are broken and give 404s. Also, there is no types.md doc page even though it's linked on the utils.md doc

sporkspatula commented 3 years ago

Hey @alexreyes congrats for being the first non-Zora engineer to put a pr! I'd like to get this in, but mind making a few changes first?

  1. Could you rename to [chore] Fixed Broken Links in Docs
  2. I don't think we need a types.md. Instead could you make the link correctly route to types.ts?
  3. To reference utils.md could you make it a relative link to the utils.md file rather than github link?

Thanks :)

alexreyes commented 3 years ago

Wow it's great to be the first non-Zora engineer to make a PR! Hopefully the first of many.

I made the changes you listed. It ended up in a couple of different commits because I was a lil scatterbrained while doing it, but it should be good now.

sporkspatula commented 3 years ago

@alexreyes Sorry for taking so long to get back to you. No worries about the length commits. I can squash them all when i merge. Fun fact: you can do this locally by doing a git rebase -i master that will allow you to interactively squash commits to make a nice and clean commit history.