docs
docs copied to clipboard
graphprotocol
Some pages of the Firehose documentation do not load
Trying to open https://thegraph.com/docs/en/firehose/integrate-new-chains/new-blockchains/ or https://thegraph.com/docs/en/firehose/integrate-new-chains/why-integrate-the-firehose/ will result in an error
Thanks @dimitrovmaksim. Looks like these two files are missing from the remote Firehose docs. One solution would be to remove the references from this file, but new-blockchains is linked to from this page, so it looks like at least that one should exist. I will check with the StreamingFast folks!
One of our writers, Paul, was investigating this. He has some ideas...will connect you.
In The Graph's documentation, there seems to be a remote access structure set up for the Firehose GitHub repository. This can be observed in the file located at website/pages/en/firehose/_meta.js.
In this file, specifically on line 71, there is a reference to a section within The Graph Docs titled "Integrating New Chains." This reference seems to connect to the content found in the file integrate-new-chains/integration-overview.md.
The above section of Graph Docs section Github is basically telling the Graph website to display the items on lines 75-78 in order under the “Integrate New Chains” section of the docs. Sort of like a table of contents
The section of the Graph Docs is here - https://thegraph.com/docs/en/firehose/integrate-new-chains/design-principles/
Below is a snapshot of the docs located in “Integrate-new-chains” but it seems to be missing the two items that are referenced above line 77 and 78, new-blockchains and why-integrate-the-firehose respectively
https://github.com/streamingfast/firehose-docs/tree/master/integrate-new-chains
I think its possible number 78 above should reference “benefits.md” below instead of “why-integrate-the-firehose”, but hard to say for certain. I am just assuming since title inside the markdown file shows same name “why integrate”, but the name on the left is not the same and would cause errors if line 78 above referenced it using the wrong name.
However I was not able to find the markdown file referenced above line 77 “New-blockchains” within the Firehose Github docs.
@PaulieB14 – The screenshots you included in your comment don't seem to load. 😬
@benface Sorry I copied from Notion and didn't work so I re-created screenshots and think it works. I don't have access to the docs that maybe missing, but let me know if you feel this is correct.
Thank you @PaulieB14. Good summary.
@saihaj – Git blame shows that you authored the website/pages/en/firehose/_meta.js file, may I ask what you used as a reference?
Also tagging @enoldev who I hear is working on the docs at StreamingFast. Any clarification would be greatly appreciated! 🙏
@saihaj – Git blame shows that you authored the website/pages/en/firehose/_meta.js file, may I ask what you used as a reference?
I had opened the tree structure and to bootstrap just started with the response from GH API https://api.github.com/repos/streamingfast/substreams/git/trees/develop?recursive=1
Thanks @saihaj (correct link for the Firehose docs since that's what this issue is about: https://api.github.com/repos/streamingfast/firehose-docs/git/trees/master?recursive=1)
Looks like why-integrate-the-firehose.md was indeed renamed to benefits.md here and new-blockchains.md was deleted here (same commit).
It's annoying to have to maintain the list of pages to ensure that it's up-to-date with the remote content's repo. Is there a way around that? cc @dimitrovmaksim
@benface I think it can be solved by parsing gitbook's SUMMARY file https://github.com/streamingfast/substreams/blob/develop/docs/SUMMARY.md?plain=1 and adopting it to Nextra's _meta.js file
In this case, we'll no longer maintain sidebar order manually
Ok, as a quick fix, let's remove this page for the moment, since it's no longer available in the Firehose docs https://github.com/graphprotocol/docs/pull/499
Next week, I'll try to implement @B2o5T's idea to parse the SUMMARY.md file.
