chore(docs): Embed docs to DevHub

[bojanrajh]

Description

This PR cleans up this repo for embedding frontends info developer-portal - shopware/developer-portal#128

Type of change

ToDo's

• removed @shopware-pwa/typer private package, moved it to @shopware-docs/typer (now public/published)
• cleaned up apps/docs folder
• added shortcuts to package.json - docs:env, docs:link and docs:preview
• added DevHub workflows for previewing and deploying changes
• static sidebar
• fixed deadlinks, added missing files
• kept package.json
• set up DEV_HUB_PERSONAL_ACCESS_TOKEN secret
• deactivate Vercel integration

Screenshots

Additional context

[vercel]

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

Name	Status	Preview	Updated (UTC)
frontends-demo	✅ Ready (Inspect)	Visit Preview	Jul 5, 2024 8:47am
shopware-frontends-docs	❌ Failed (Inspect)		Jul 5, 2024 8:47am

[codspeed-hq]

CodSpeed Performance Report

Merging #493 will not alter performance

_{Comparing DX-devhub (a8f4588) with main (f9d2735)}

Summary

✅ 9 untouched benchmarks

[BrocksiNet]

What is missing? Can we somehow support it? Asking for a friend.

[bojanrajh]

What is missing? Can we somehow support it? Asking for a friend.

I'll rebase, sync the typer package, then we can talk about the new docs workflow. You can still use your old (isolated) and new (embedded) workflows, and this branch is already published to prod (though not linked in the menu, it is searchable by Algolia and contents are provided to the Copilot AI).

[bojanrajh]

@BrocksiNet This was rebased, but generated API references are not working on prod because of the new plugin structure. We'll need to adapt that on our end.

[BrocksiNet]

@BrocksiNet This was rebased, but generated API references are not working on prod because of the new plugin structure. We'll need to adapt that on our end.

Thx @bojanrajh 🙌 Great work.

We discussed updating our docs to the newest Vitepress version (see).
Do you see any problem with that? 😀

[bojanrajh]

Technically, you could see changes in theme.json and package.json in this branch. You can also use clean version of config.ts (because config is already in baseConfig (and sidebar.ts). Keep your plugin definition and you should be good with your standalone docs.

This branch already includes the latest version, but there are 2 breaking changes: API reference (though, it should be properly generated in the standalone version, but not in the DevHub context) and local search (replaced with algolia). Along with possible minor CSS changes from past months (I did apply some stuff from this repo into the theme already).

[bojanrajh]

Closing in favour of #1313, #1327 and #1337.