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

Some pages of the Firehose documentation do not load #477

Open
dimitrovmaksim opened this issue Aug 18, 2023 · 11 comments
Open

Some pages of the Firehose documentation do not load #477

dimitrovmaksim opened this issue Aug 18, 2023 · 11 comments

Comments

@dimitrovmaksim
Copy link
Member

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

Screenshot 2023-08-18 at 7 02 35 Screenshot 2023-08-18 at 7 02 59
@benface
Copy link
Contributor

benface commented Aug 25, 2023

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!

@KevinEOSNation
Copy link

One of our writers, Paul, was investigating this. He has some ideas...will connect you.

@PaulieB14
Copy link

PaulieB14 commented Aug 29, 2023

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.

Screenshot 2023-08-29 at 3 17 06 PM

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/

Screenshot 2023-08-29 at 3 17 55 PM

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

Screenshot 2023-08-29 at 3 19 08 PM

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.

Screenshot 2023-08-29 at 3 19 54 PM

However I was not able to find the markdown file referenced above line 77 “New-blockchains” within the Firehose Github docs.

@benface
Copy link
Contributor

benface commented Aug 29, 2023

@PaulieB14 – The screenshots you included in your comment don't seem to load. 😬

@PaulieB14
Copy link

@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.

@benface
Copy link
Contributor

benface commented Aug 29, 2023

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
Copy link
Member

saihaj commented Aug 29, 2023

@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

@benface
Copy link
Contributor

benface commented Aug 29, 2023

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
Copy link
Contributor

benface commented Aug 31, 2023

I meant to tag @B2o5T in my last comment (sorry @/dimitrovmaksim)

@dimaMachina
Copy link
Contributor

@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

@enoldev
Copy link
Collaborator

enoldev commented Sep 1, 2023

Ok, as a quick fix, let's remove this page for the moment, since it's no longer available in the Firehose docs #499

Next week, I'll try to implement @B2o5T's idea to parse the SUMMARY.md file.

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

No branches or pull requests

7 participants