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

docs: Fix anchors referenced to Network page #406

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

aefhm
Copy link
Contributor

@aefhm aefhm commented Sep 20, 2024

Description

Fix links introduced in #402.

  Exhaustive list of all broken anchors found:
  - Broken anchor on source page path = /dapp/sapphire/browser:
     -> linking to /dapp/sapphire/#testnet
  - Broken anchor on source page path = /dapp/sapphire/guide:
     -> linking to /dapp/sapphire/#rpc-endpoints

https://github.com/oasisprotocol/docs/actions/runs/10951224600/job/30407909516?pr=940

@aefhm aefhm self-assigned this Sep 20, 2024
Copy link

netlify bot commented Sep 20, 2024

Deploy Preview for oasisprotocol-sapphire-paratime failed.

Name Link
🔨 Latest commit 81fb377
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-sapphire-paratime/deploys/66ef3752701eb700081a6c0c

@aefhm aefhm requested a review from rube-de September 20, 2024 01:31
@aefhm aefhm added the docs Documentation label Sep 20, 2024
@CedarMist CedarMist self-requested a review September 20, 2024 08:53
Copy link
Member

@CedarMist CedarMist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Netlify build is still failing

1:59:06 AM: [ERROR] Client bundle compiled with errors therefore further build is impossible.
1:59:06 AM: Error: MDX compilation failed for file "/opt/build/repo/docs/.oasis-docs/docs/dapp/sapphire/browser.md"
1:59:06 AM: Cause: Docs markdown link couldn't be resolved: (./network.mdx) in source file "/opt/build/repo/docs/.oasis-docs/docs/dapp/sapphire/browser.md" for version current
Details:
1:59:06 AM: Error: Docs markdown link couldn't be resolved: (./network.mdx) in source file "/opt/build/repo/docs/.oasis-docs/docs/dapp/sapphire/browser.md" for version current

@rube-de
Copy link
Contributor

rube-de commented Sep 20, 2024

is there a way to rerun the deploy preview?
I think this is fixed with the bump of the submodule in doc.

@aefhm
Copy link
Contributor Author

aefhm commented Sep 20, 2024

is there a way to rerun the deploy preview? I think this is fixed with the bump of the submodule in doc.

Yeah. We can rerun the job, and that should trigger it. In this case, I don't think the bump would work because the docs referred to this build is the main branch head which does not have symlinks introduced in oasisprotocol/docs#940 to find the correct ./network.mdx file.

9:38:18 AM: [ERROR] Client bundle compiled with errors therefore further build is impossible.
9:38:18 AM: Error: MDX compilation failed for file "/opt/build/repo/docs/.oasis-docs/docs/dapp/sapphire/browser.md"
9:38:18 AM: Cause: Docs markdown link couldn't be resolved: (./network.mdx) in source file "/opt/build/repo/docs/.oasis-docs/docs/dapp/sapphire/browser.md" for version current
Details:
9:38:18 AM: Error: Docs markdown link couldn't be resolved: (./network.mdx) in source file "/opt/build/repo/docs/.oasis-docs/docs/dapp/sapphire/browser.md" for version current
error Command failed with exit code 1. (https://ntl.fyi/exit-code-1)

I believe this is just a quirk of the current setup which is fine because deployment of the docs happen from https://github.com/oasisprotocol/docs repository, so we can freely bump sapphire-paratime without breaking end user experience. We just have to ensure that the preview works correctly in docs before merging.

Note that most workflow functionality with Netlify preview should work as expected with the exception of these scenarios where a new file is introduced and referenced immediately. One workaround is to introduce a non-breaking change PR A in this repository. Update docs with PR B, and then opt for removal with PR C here.

@aefhm
Copy link
Contributor Author

aefhm commented Sep 20, 2024

I'll give a stab to the symlink directory solution @CedarMist suggested separately. oasisprotocol/docs#951

@aefhm aefhm force-pushed the xz/fix-anchors branch 2 times, most recently from d2732f0 to 81fb377 Compare September 21, 2024 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: move chain info to separate page
3 participants