docs: v3-first documentation, v2 archived under a legacy section - #233
Open
afonsojramos wants to merge 11 commits into
Open
docs: v3-first documentation, v2 archived under a legacy section#233afonsojramos wants to merge 11 commits into
afonsojramos wants to merge 11 commits into
Conversation
oxfmt ignores md, mdx, yaml, html and css, but lint-staged handed it exactly those types, so any commit whose staged set was entirely markdown (most commits in a docs repo) died on "Expected at least one target file". The glob now matches what oxfmt actually formats.
The site described v2 exclusively. The main tree is now v3 (install and first module, what changes from v2, modules and the store, config.toml, the CLI reference written from the binary's own help, building and publishing a module), and every v2 page keeps its content under /docs/legacy behind a banner pointing at its v3 equivalent, with a redirect for each URL that moved. The API reference is shared by both and was checked against a running v3 client: the Panel surface and GraphQL.Definitions are gone, PlatformData lost three documented fields and gained three undocumented ones, and isPlaylistV2URI is isPlaylistV2. Those pages now say so. Also removes the duplicate root docs/ tree. Only src/content/docs builds, the two were kept in sync by hand, and PR #222 had to patch both.
…ction rules Getting started and the CLI reference now say a fresh apply seeds stdlib and the store, which is what makes the store present without a manual install. The trashbin enable examples used a real version that would age, so they point at the version pkg install prints. Also removes the horizontal rules between sections and one 'should'.
Deploying spicetify-docs with
|
| Latest commit: |
a992031
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1ae67f62.spicetify-docs.pages.dev |
| Branch Preview URL: | https://v3.spicetify-docs.pages.dev |
The action moved out of spicetify/modules into its own repo so authors can pin a stable v1 instead of an unversioned @main.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites the site around Spicetify v3, keeping every v2 page under
/docs/legacyso nothing that is indexed 404s. Open as a preview: the install pages assume a published v3 release, so this should land close to the firstv3*tag rather than before it.What changes
config.tomlreference, a CLI reference written from the binary's own--help, and building + publishing a module./docs/legacy, each page carrying a banner that links to its v3 equivalent, with a redirect for every URL that moved.GraphQL.Definitionsare gone,PlatformDatalost three documented fields and gained three undocumented ones, andisPlaylistV2URIis nowisPlaylistV2. Those pages say so.docs/tree. Onlysrc/content/docsbuilds; the two were kept in sync by hand, and PR Fix broken Themes → Marketplace relative link #222 had to patch both.Verification
bun run build— 101 pagesoxlintandoxfmt --checkclean/docslink and sidebar entry resolves against a page that exists or a redirect (95 pages, 23 redirects)Note before merging
install.sh --v3and the Windows$v3one-liner only become true statements once av3*release exists. Merge alongside the first beta tag.