add ordhook docs #514
add ordhook docs #514
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
docs/ordhook/how-to-guides/how-to-explore-ordinal-activities.md
Outdated
Show resolved
Hide resolved
docs/ordhook/how-to-guides/how-to-explore-ordinal-activities.md
Outdated
Show resolved
Hide resolved
docs/ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/ordhook/how-to-guides/how-to-use-ordhook-as-a-service-using-bitcoind.md
Outdated
Show resolved
Hide resolved
docs/ordhook/getting-started.md
Outdated
| title: Getting Started | ||
| --- | ||
|
|
||
| Ordhook is a utility designed for interacting with the [Ordinal Theory](https://trustmachines.co/glossary/ordinal-theory) protocol, enabling you to assign distinct identifiers to newly minted satoshis for diverse applications. Follow the steps below to install Ordhook. |
There was a problem hiding this comment.
utility: tool? command line tool? developer tool?
There was a problem hiding this comment.
updates here: hirosystems/ordhook#184
docs/ordhook/getting-started.md
Outdated
| Use the Rust package manager, Cargo, to install Ordhook. Run the following command: | ||
|
|
||
| ```bash | ||
| cargo ordhook-install |
There was a problem hiding this comment.
This command requires to have cargo installed. Considering how detailed our approach is in this guide (cd, git clone, etc) I think we should provide a guide (or provide a pointer) on how to install rust.
There was a problem hiding this comment.
updates here: hirosystems/ordhook#184
There was a problem hiding this comment.
@ryanwaits: Your assembly of remote docs from https://github.com/hirosystems/ordhook/tree/develop/docs and the related config changes looks good; however, I am confused as to why you would want the overview.md and getting-started.md files locally also.
They are at the upstream repo, anyway: https://github.com/hirosystems/ordhook/tree/develop/docs
I think simply pointing to those files where the remote plugin dumped in the sidebar.js is all you would need.
I could be misinterpreting, and I am on standby to be corrected.
|
yeah that's nbd, i deleted them locally and will have them ignored by git moving forward otherwise i think these updates should be in a good spot to go ahead and publish, lmk if we're good to approve! |
Adding Ordhook documentation to sidebar