Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

[Feat.Req] Add link to docs in README.md #137

Closed
matthewdarwin opened this issue May 11, 2023 · 4 comments · Fixed by #144
Closed

[Feat.Req] Add link to docs in README.md #137

matthewdarwin opened this issue May 11, 2023 · 4 comments · Fixed by #144
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@matthewdarwin
Copy link

Problem statement
Allow the docs to be discoverable when starting from this github repo.

Expectation proposal
Add a link to https://docs.graphops.xyz/graphcast/radios/poi-radio

Alternative considerations
Do nothing. Make me fumble around.

Additional context
none

@matthewdarwin matthewdarwin changed the title [Feat.Req] Add link to docs from README.md [Feat.Req] Add link to docs in README.md May 11, 2023
@jhjhjh94
Copy link

jhjhjh94 commented May 11, 2023

Also...

According to this https://docs.graphops.xyz/graphcast/radios/poi-radio
If possible please provide address or add Arbitrum Registry URL to call setGraphcastIDFor.

@hopeyen
Copy link
Collaborator

hopeyen commented May 15, 2023

Thanks for the suggestion Matthew! We already have a link to the docs, it is the first thing in the README. To be clear, you can click the docs button I highlighted with a blue box in the screenshot below.
Screenshot 2023-05-15 at 9 42 10 AM
Is it not clear enough to the readers? Do you think people would find it useful if the link is explicitly written out?

--

Hey @jhjhjh94, we currently do not have an Arbitrum Registry, I will add that as a task with high priority

@hopeyen
Copy link
Collaborator

hopeyen commented May 15, 2023

To be clear, you can click the docs button I highlighted with a blue box in the screenshot below.

The doc link is also here, but let us know if there are more preferred places.
Screenshot 2023-05-15 at 9 52 42 AM

@hopeyen hopeyen self-assigned this May 15, 2023
@hopeyen hopeyen added the documentation Improvements or additions to documentation label May 15, 2023
@matthewdarwin
Copy link
Author

I totally skip over the batches when reading. I'm looking for "docs" section.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants