Unversion Architecture docs

[slorber]

Move out the Architecture tabs docs/sidebar from the versioned docs, as discussed with @cortinico @kelset @Simek

I created a second Docusaurus docs plugin instance and moved the Architecture docs there + removed the versioned Architecture docs.

As far as I understand you eventually plan to add more unversioned docs, so I named this instance (and folders) docs_unversioned so that it is future proof, as it was mentioned some other docs (contributing, tests...) could also be unversioned later.

Also used routeBasePath: '/' so that all those docs can have a top-level url: using frontMatter slug: /architecture means the doc will be hosted at /architecture and not /docs_unversioned/architecture. It's up to you to decide if all unversioned docs must be hosted under a shared path segment prefix.

Obviously, the older versioned URLs are slightly different compared to before, so make sure to review this part if you want.
We can set up server-side redirects through Netlify's _redirect file if you feel it's necessary

Deploy preview: https://deploy-preview-3000--react-native.netlify.app/architecture/overview

[Simek]

@slorber Can't we just move the files to the website root, and put them in the architecture directory, just like it has been done in Contributing PR? This will allow use to ditch docs_unversioned in path, which I'm not a big fan of, and simplifies the setup. See:

• Moving Release Wiki to react-native-website #2961

[netlify]

✔️ Deploy Preview for react-native ready!

🔨 Explore the source changes: c2359c8

🔍 Inspect the deploy log: https://app.netlify.com/sites/react-native/deploys/622a04f121349200087ed039

😎 Browse the preview: https://deploy-preview-3000--react-native.netlify.app

[slorber]

@slorber Can't we just move the files to the website root, and put them in the architecture directory, just like it has been done in Contributing PR? This will allow use to ditch docs_unversioned in path, which I'm not a big fan of, and simplifies the setup. See:

• Moving Release Wiki to react-native-website #2961

Didn't know there was already such a PR

We can definitively do that.

It depends if you want to gather all unversioned docs into the same folder and under the same url prefix (can be /) or if you want to use multiple unversioned docs instances (more config/boilerplate, but more flexibility)

Note: Docusaurus currently doesn't support 2 plugin instances using both routeBasePath: '/' at the same time.

[Simek]

Can we use the routeBasePath: 'architecure' and make the overview page avaible under architecure/overview instead? Generally I like the way in which this has been setup in the mentioned above PR, not sure what's the others opinion tho.

Also, we currently do not support accessing or redirect from the root path anyway - https://deploy-preview-3000--react-native.netlify.app/docs.

[slorber]

I updated the PR to match the choices already made on the other PR #2961

=> one docs plugin instance per unversioned type of content

[lunaleaps]

lgtm! Will let you and @Simek coordinate how to merge

[Simek]

I think that the last thing which left there is to define redirect for the moved pages, since the in all communication related to the New Arch before we have used the versioned links. It would be nice to keep them working, without the redirects the links will lead to 404.

[kelset]

thanks for all your work 👏👏👏

One thing I was wondering - could we maybe add to the readme.md (or the contributing.md) for this repo the instructions for how to add an unversioned section (/move something to unversioned)? I mean, I'm not expecting many more aside from this and the contributing one to be unversioned, but would be good to have some reference to look at.

By taking a quick look at this PR, it seems that there are a few things do to:

• the .md files need to be in their own folder at root level of the website folder
• docusaurus.config.js need a direct reference
• the category needs to not be in the sidebars.json but in their own sidebars"nameOfCategory".json
• might have to add some references in static/_redirects to ensure that old urls get pointed to the new places

anything else?

[cortinico]

That's amazing, thanks for tackling this @slorber

I've quickly checked the setup and it looks good to me. I'd defer the full review to @Simek and @kelset which already pointed out the most important changes.

[slorber]

👍 I'll let @Simek follow-up

Docusaurus has a dedicated doc page for docs plugin multi-instance, which is exactly what we are using here: https://docusaurus.io/docs/docs-multi-instance

But it's possible to be more specific to the RN website use case, or eventually improve our official doc if you feel something should be clarified

[Simek]

I have backported the changes to the New Arch pages which were causing the conflicts, I have also extracted the common docs options to the separate object which is then spread into all of the docs configs. After those changes and PR seems to be ready to merge.

I have also tested the redirects on the deploy preview and everything seems to be alright.

Big thanks for the @slorber for all the work he has done here, for the tips and guidance, also thanks to the others who posted the reviews and provided great feedback! ❤️

Let's ship it! 🚀

[kelset]

@Simek just to be clear:

• contributing section is still versioned
• readme still doesn't have info about unversioning stuff

right? Did I miss something?

Not a big deal, we can handle with a follow up PR, just want to make sure we're not losing pieces down the road

[Simek]

• contributing section is still versioned

It should be unversioned, as it was when I was testing the PR last time:

• https://reactnative.dev/contributing/how-to-contribute

• readme still doesn't have info about unversioning stuff

Not a big deal, we can handle with a follow up PR, just want to make sure we're not losing pieces down the road

Nope, but we can expand few sentences here and there, as well as update the directories structure schema in Readme.

But generally I think that linking to the Docusaurus docs for the non-custom stuff is a good approach. Feel free to propose PR here and to the Docusaurus website (if needed). If you not interested in this, I will add updating the instructions to my TODOs and look at this soon.

[kelset]

sounds good, thanks for the clarifications Simek!