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 directory restructure: Partials, images, third-party docs #1247

Draft
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

symbolpunk
Copy link
Contributor

@symbolpunk symbolpunk commented May 7, 2024

Note that some file relocations in this PR do not include the addition of a number prefix - intent is to address those types of non-blocking todos in a separate PR.

TODOs before merging:

  • test yarn update:all
  • test 3p docs catch-all redirect

@cla-bot cla-bot bot added the s label May 7, 2024
Copy link

vercel bot commented May 7, 2024

Deployment failed with the following error:

Redirect at index 1 has segment ":slug" in `destination` property but not in `source` or `has` property.

Learn More: https://vercel.link/invalid-route-destination-segment

Copy link

vercel bot commented May 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
arbitrum-docs ✅ Ready (Inspect) Visit Preview Jul 9, 2024 9:31pm

"permanent": false
},
{
"source": "/for-devs/third-party-docs/:slug*",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

cc @TucksonDev - what I referred to in chat

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, that's very nice! 🔥
Is it possible to add the /? at the end? It's not critical, imo, but the current links have a / at the end, and fail to redirect if we add that (e.g. https://arbitrum-docs-git-file-restructure-6-offchain-labs.vercel.app/for-devs/third-party-docs/Envio/).

</a>
.
</p>
<p>Yes! Arbitrum Orbit's core technology has undergone a comprehensive audit and is now able to support deployments to mainnet. You can read more about it <a href="https://docs.arbitrum.io/launch-orbit-chain/concepts/public-preview-expectations#arbitrum-orbit-is-mainnet-ready-but-deploy-to-testnet-first">here</a>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you run yarn format one more time to remove these changes?

Copy link
Contributor

@TucksonDev TucksonDev left a comment

Choose a reason for hiding this comment

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

Amazing job, sir! 🚀
I've left 2 minor comments, but more importantly, can you merge master into it and resolve the conflicts? master has now docusaurus 3, which I suppose doesn't really affect these changes, but I'd like to take a final look with that branch merged 🙏

Copy link
Contributor

@anegg0 anegg0 left a comment

Choose a reason for hiding this comment

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

This looks so good, I want to cry!
I left for @TucksonDev and you to resolve the trailing slash issue.

@symbolpunk symbolpunk marked this pull request as draft May 22, 2024 23:09
Copy link

cla-bot bot commented Jul 9, 2024

We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2

"permanent": false
},
{
"source": "/for-devs/third-party-docs/:slug*",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"source": "/for-devs/third-party-docs/:slug*",
"source": "/for-devs/third-party-docs/:slug*/?",

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the modification you required, @TucksonDev?

Copy link
Contributor

@anegg0 anegg0 left a comment

Choose a reason for hiding this comment

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

@TucksonDev, picking this up, I added the modification you requested (hopefully, I got it right!).

Copy link

cla-bot bot commented Jul 9, 2024

We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants