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.

Sign up for GitHub

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

Jump to bottom

chore(docs): Embed docs to DevHub #493

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

chore(docs): Embed docs to DevHub #493

wants to merge 1 commit into from

Conversation

bojanrajh
Copy link
Contributor

@bojanrajh bojanrajh commented Dec 6, 2023 •
edited

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

@bojanrajh bojanrajh added the documentation Improvements or additions to documentation label Dec 6, 2023
@vercel Vercel
Copy link

vercel bot commented Dec 6, 2023 •
edited

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

Name Status Preview Updated (UTC)
frontends-demo ✅ Ready (Inspect) Visit Preview Mar 4, 2024 9:24am
shopware-frontends-docs ✅ Ready (Inspect) Visit Preview Mar 4, 2024 9:24am

@bojanrajh bojanrajh changed the title Dx devhub chore(docs): Embed docs to DevHub Dec 6, 2023
@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Feb 16, 2024 •
edited

CodSpeed Performance Report

Merging #493 will not alter performance

Comparing DX-devhub (666221b) with main (faf5fd0)

Summary

✅ 9 untouched benchmarks

@bojanrajh
feat: add workflows
666221b 
feat: remove typer

feat: cleanup vitepress theme

feat: extract sidebar

feat: after-install scripts

feat: pass wd

feat: add shortcuts

fix: deadlinks

feat: add missing articles

feat: keep source when symlinking

feat: revert package.json

feat: cleanup

vercel

fix: build

fix: logo

feat: algolia

feat: remove typer
@BrocksiNet
Copy link
Collaborator

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

@bojanrajh
Copy link
Contributor Author

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bojanrajh @BrocksiNet