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

Fix build errors, add hardcoded ACP explainer #1803

Merged
merged 9 commits into from
Jul 31, 2024
Merged

Conversation

meaghanfitzgerald
Copy link
Collaborator

Why this should be merged

the build has been broken due to invalid sourceBaseUrls in remoteContent.js. These Urls point to .md files in remote repositories (ie. https://github.com/ava-labs/avalanchego/) that are pulled into docs via docusaurus-plugin-remote-content community plugin.

I wrote a detailed guide on how I implemented docusaurus-plugin-remote-content to pull remote docs. Many FAQs are answered there.

How this works

  • changes the invalid URLs to valid URLs
  • removed the ACP remote URLs and replaced with a hardcoded file in docs/learn/acp.md

How these changes were tested

yarn build
yarn start

Copy link

cloudflare-workers-and-pages bot commented Jul 31, 2024

Deploying avalanche-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 58a6e67
Status: ✅  Deploy successful!
Preview URL: https://7f3eee83.avalanche-docs.pages.dev
Branch Preview URL: https://meag-fix-build.avalanche-docs.pages.dev

View logs

Comment on lines -274 to +282
"https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/Teleporter/upgrades/",
"https://raw.githubusercontent.com/ava-labs/teleporter/main/contracts/src/teleporter/registry/",
documents: ["README.md"],
outDir: "docs/build/cross-chain/teleporter/",
// change file name and add metadata correct links
modifyContent(filename, content) {
if (filename.includes("README")) {
const updatedContent = replaceRelativeLinks(
content,
"https://github.com/ava-labs/teleporter/blob/main/contracts/src/Teleporter/upgrades/"
"https://github.com/ava-labs/teleporter/blob/main/contracts/src/teleporter/registry/"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

these were the broken urls

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@meaghanfitzgerald
Copy link
Collaborator Author

/gt docs/learn/acp.md i18n/es/docusaurus-plugin-content-docs/current/learn/acp.md spanish

Copy link
Contributor

🎉Translation completed!

@laviniat1996
Copy link
Contributor

thank you @meaghanfitzgerald for this contribution

@laviniat1996 laviniat1996 merged commit 87d4db6 into master Jul 31, 2024
8 checks passed
@martineckardt martineckardt deleted the meag/fix-build branch January 3, 2025 15:58
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

Successfully merging this pull request may close these issues.

2 participants