SvelteKit powered docs site + refresh brand guidelines
Replaces Eleventy for a SvelteKit powered docs site:
- New docs can be added as .md files in
packages/stacks-docs/src/docs/ - For complex documentation requiring images and interactivity you can also create a folder with an
index.md. See/packages/stacks-docs/src/docs/public/brand/typography/as an example. - Navigation is updated by editing
packages/stacks-docs/src/structure.yaml - ⚠️ In-progress: Migrate old stacks documentation to svelte powered, using
stacks-sveltewhere appropriate. This can be ongoing work as we build out new sections. - Upgraded Agolia DocSearch, although now setup with the new structure yet.
To get started:
npm i
npm run dev -w packages/stacks-site
Adds support for gated documentation for employees, this is useful for non-technical folks finding brand or design related information e.g., location of internal presentation decks, brand strategy details.
Employees will need access to StackEng/StacksDocsPrivate and SSH authentication setup when cloning.
git clone -b beta https://github.com/StackExchange/Stacks.git
cd ./Stacks
git submodule update --init --recursive
Change beta to new-ui to test this branch
⚠️ No Changeset found
Latest commit: 7917691f66dfb10a09bbf41f75dc7141ce7f1218
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
Deploy Preview for stacks ready!
| Name | Link |
|---|---|
| Latest commit | 7917691f66dfb10a09bbf41f75dc7141ce7f1218 |
| Latest deploy log | https://app.netlify.com/projects/stacks/deploys/694584cd59a545000894f7c8 |
| Deploy Preview | https://deploy-preview-2102--stacks.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
Deploy Preview for stacks-svelte failed. Why did it fail? →
| Name | Link |
|---|---|
| Latest commit | 7917691f66dfb10a09bbf41f75dc7141ce7f1218 |
| Latest deploy log | https://app.netlify.com/projects/stacks-svelte/deploys/694584cc59a545000894f7c6 |
Moving this work to alpha branch, will reopen a PR when we are closed to a switchover