diff --git a/README.md b/README.md index 1a56ed9e5..9e7073cf2 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ These are static markdown pages that can be added and edited directly within the #### Examples -These are markdown compilations of the JS files on the `src/examples` directory. They are also versioned to match the versions of the docs snapshots. Only the `docs/examples/index.md` entry point can be altered, but the examples themselves should be worked on from within the `src/examples/{version}` directories. Once updated, the command below can be called to generate out the markdown compilations of the examples. +These are markdown compilations of the JS files on the `src/examples` directory. They are also versioned to match the versions of the docs snapshots. If the exact version of the example is not found, it will fallback to the best-matched most recent version of the examples. be Only the `docs/examples/index.md` entry point can be altered, but the examples themselves should be worked on from within the `src/examples/{version}` directories. Once updated, the command below can be called to generate out the markdown compilations of the examples. ``` $ npm run generate-example-docs @@ -51,7 +51,7 @@ __Note__: The examples within the docs version active on the website will be sho #### Tutorials -These also markdown compilations of groups of files on the `src/tutorials` directory. Each tutorial group consists of a number of steps where each step contains a JS code file accompanied by an instruction markdown file, and a separate completed JS code file if there is a next step to proceed towards. These completed code can be toggled on/off from the instruction card of the corresponded step. Like the examples, these are also versioned to match the versions of the docs snapshots. Only the `docs/tutorials/index.md` entry point can be altered, but the tutorial groups themselves should be worked on from within the `src/tutorial/{version}` directories. Once updated, the command below can be called to generate out the markdown compilations of the tutorial groups. +These also markdown compilations of groups of files on the `src/tutorials` directory. Each tutorial group consists of a number of steps where each step contains a JS code file accompanied by an instruction markdown file, and a separate completed JS code file if there is a next step to proceed towards. These completed code can be toggled on/off from the instruction card of the corresponded step. Like the examples, these are also versioned to match the versions of the docs snapshots and will fallback to the best-matched most recent version of the tutorials if the exact version is not found. Only the `docs/tutorials/index.md` entry point can be altered, but the tutorial groups themselves should be worked on from within the `src/tutorial/{version}` directories. Once updated, the command below can be called to generate out the markdown compilations of the tutorial groups. ``` $ npm run generate-tutorial-docs @@ -67,6 +67,8 @@ $ npm start The local development command will also trigger the `generate-content` command which, in turns, calls the `generate-example-docs` script and `generate-tutorial-docs` script respectively. Since the compiled markdown pages contain dynamic components, changes within the examples source or the tutorials source will be reflected on hot reloads. +However, when adding or removing tutorials or examples, please make sure to re-do `npm start` or run `generate-content` manually to keep the markdown pages of these content up-to-date. + #### Versioning Docs versioning is native to Docusaurus, but to make it easier to manage it is coupled with the PixiJS version. A `pixi-version.json` is required on the working docs directory to create a versioned snapshot of the docs. This can be generated and altered using the following command: @@ -83,7 +85,7 @@ Once satisfied with the state of the working docs and wanting to create a snapsh $ npm run create-docs-version-snapshot ``` -This will copy everything from the working docs into its own directory within the `versioned_docs` directory and named correspondingly to the version number from the encapsulated `pixi-version.json`. The command will also trigger `update-global-version-config` script which adds the pixi version config to the master `pixi-versions.json` on the root and alter the version config on the `docusaurus.config.js` accordingly. Docusaurus will also add the version to its `versions.json` file on the root. +This will copy everything from the working docs into its own directory within the `versioned_docs` directory and named correspondingly to the version number from the encapsulated `pixi-version.json`, if chosen to be created as a specific version snapshot. If chosen to be snapshot as a generic version then the version key will be simplified to `{major}.x` (eg. `7.x`). Generic version snapshot is recommended over the specific one for maintaining major docs, but for a major version where multiple versions of docs are needed then the ability to create specific version snapshots can be handy. The command will also trigger `update-global-version-config` script which adds the pixi version config to the master `pixi-versions.json` on the root and alter the version config on the `docusaurus.config.js` accordingly. Docusaurus will also add the version to its `versions.json` file on the root. An existing docs snapshot can be removed using the following command: diff --git a/docs/pixi-version.json b/docs/pixi-version.json index 70c33d85c..8a7ee5569 100644 --- a/docs/pixi-version.json +++ b/docs/pixi-version.json @@ -1,5 +1,5 @@ { - "versionLabel": "prerelease-v8", + "versionLabel": "v8.x", "version": "8.0.0-rc.4", "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v8.0.0-rc.4", "build": "https://pixijs.download/v8.0.0-rc.4/pixi.min.js", diff --git a/docusaurus.config.js b/docusaurus.config.js index b514113d2..ba0de3d17 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -43,15 +43,15 @@ const config = { editUrl: 'https://github.com/pixijs/pixijs.com/tree/main/', routeBasePath: '/', versions: { - '7.3.3': { + '7.x': { label: 'v7.x (Latest)', - path: '7.3.3', + path: '7.x', banner: 'none', badge: false, }, current: { - label: 'prerelease-v8', + label: 'v8.x', banner: 'none', badge: false, }, diff --git a/legacy-pixi-versions.json b/legacy-pixi-versions.json new file mode 100644 index 000000000..c20cbbd47 --- /dev/null +++ b/legacy-pixi-versions.json @@ -0,0 +1,50 @@ +[ + { + "versionLabel": "v7.2.x", + "version": "7.2.4", + "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v7.2.4", + "build": "https://pixijs.download/v7.2.4/pixi.min.js", + "docs": "https://pixijs.download/v7.2.4/docs/index.html", + "npm": "7.2.4" + }, + { + "versionLabel": "v7.1.x", + "version": "7.1.4", + "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v7.1.4", + "build": "https://pixijs.download/v7.1.4/pixi.min.js", + "docs": "https://pixijs.download/v7.1.4/docs/index.html", + "npm": "7.1.4" + }, + { + "versionLabel": "v7.0.x", + "version": "7.0.5", + "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v7.0.5", + "build": "https://pixijs.download/v7.0.5/pixi.min.js", + "docs": "https://pixijs.download/v7.0.5/docs/index.html", + "npm": "7.0.5" + }, + { + "versionLabel": "v6.x", + "version": "6.5.10", + "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v6.5.10", + "build": "https://pixijs.download/v6.5.10/pixi.min.js", + "docs": "https://pixijs.download/v6.5.10/docs/index.html", + "npm": "6.5.10" + }, + { + "versionLabel": "v5.x", + "version": "5.3.12", + "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v5.3.12", + "build": "https://pixijs.download/v5.3.12/pixi.min.js", + "docs": "https://pixijs.download/v5.3.12/docs/index.html", + "npm": "5.3.12" + }, + { + "versionLabel": "v4.x", + "version": "4.8.9", + "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v4.8.9", + "build": "https://pixijs.download/v4.8.9/pixi.min.js", + "docs": "https://pixijs.download/v4.8.9/docs/index.html", + "npm": "4.8.9" + } +] \ No newline at end of file diff --git a/pixi-dev-versions.json b/pixi-dev-versions.json new file mode 100644 index 000000000..21de0073a --- /dev/null +++ b/pixi-dev-versions.json @@ -0,0 +1,18 @@ +[ + { + "versionLabel": "dev", + "version": "dev", + "releaseNotes": "https://github.com/pixijs/pixijs/releases", + "build": "https://pixijs.download/dev/pixi.min.js", + "docs": "https://pixijs.download/dev/docs/index.html", + "dev": true + }, + { + "versionLabel": "next-v8", + "version": "next-v8", + "releaseNotes": "https://github.com/pixijs/pixijs/releases", + "build": "https://pixijs.download/next-v8/pixi.min.js", + "docs": "https://pixijs.download/next-v8/docs/index.html", + "dev": true + } +] \ No newline at end of file diff --git a/pixi-versions.json b/pixi-versions.json index d6fa88976..80bba9073 100644 --- a/pixi-versions.json +++ b/pixi-versions.json @@ -11,7 +11,7 @@ "isCurrent": false }, { - "versionLabel": "prerelease-v8", + "versionLabel": "v8.x", "version": "8.0.0-rc.4", "releaseNotes": "https://github.com/pixijs/pixijs/releases/tag/v8.0.0-rc.4", "build": "https://pixijs.download/v8.0.0-rc.4/pixi.min.js", diff --git a/scripts/create-docs-version-snapshot.js b/scripts/create-docs-version-snapshot.js index bf0fc739e..722dc4bb0 100644 --- a/scripts/create-docs-version-snapshot.js +++ b/scripts/create-docs-version-snapshot.js @@ -1,49 +1,75 @@ const { unlinkSync, existsSync, readFileSync } = require('fs'); const shell = require('shelljs'); const { join, resolve } = require('path'); +const inquirer = require('inquirer'); const docsDir = './docs'; const versionFile = join(docsDir, 'pixi-version.json'); +function getGenericVersion(version) +{ + return version.replace(/(\d+)(\.\d+)?(\.\d+)?(-.*)?/, '$1.x'); +} + console.log('Creating a version snapshot of the docs...'); try { - // Generate pixi-version.json if it doesn't exist - if (!existsSync(versionFile)) + (async () => { - console.log( - 'Aborting snapshot - Pixi version config not found on the working docs.', - 'please generate one first using \'npm run generate-pixi-version-config\'', - ); + // Generate pixi-version.json if it doesn't exist + if (!existsSync(versionFile)) + { + console.log( + 'Aborting snapshot - Pixi version config not found on the working docs.', + 'please generate one first using \'npm run generate-pixi-version-config\'', + ); - shell.exit(0); - } + shell.exit(0); + } - // Read pixi-version.json to get the version - const version = JSON.parse(readFileSync(versionFile, 'utf8')).version; + // Read pixi-version.json to get the version + const version = JSON.parse(readFileSync(versionFile, 'utf8')).version; - // Check if a snapshot of the version already exists - if (existsSync(join(docsDir, `versioned_docs/version-${version}`))) - { - console.log( - `Aborting snapshot - Snapshot for version ${version} already exists.`, - `Please do 'npm run overwrite-docs-version-snapshot' instead to`, - `overwrite an existing snapshot with the current docs content.`, - ); - shell.exit(0); - } + // Grab the generic version as an option for user to choose as well + const genericVersion = getGenericVersion(version); + + // Let the user choose between snapshotting the specific version or the generic version + const choice = await inquirer.prompt([ + { + type: 'list', + name: 'selected', + message: 'Would you like to snapshot as a generic or a specific version?', + choices: [genericVersion, version], + default: genericVersion, + loop: false, + }, + ]); + + const selectedVersion = choice.selected; - // Run docusaurus version with the version - shell.exec(`npm run docusaurus docs:version ${version}`); + // Check if a snapshot of the version already exists + if (existsSync(join(docsDir, `versioned_docs/version-${selectedVersion}`))) + { + console.log( + `Aborting snapshot - Snapshot for version ${selectedVersion} already exists.`, + `Please do 'npm run overwrite-docs-version-snapshot' instead to`, + `overwrite an existing snapshot with the current docs content.`, + ); + shell.exit(0); + } - // Then update the global version configs accordingly - shell.exec('npm run update-global-version-configs'); + // Run docusaurus version with the version + shell.exec(`npm run docusaurus docs:version ${selectedVersion}`); - console.log( - `** pixi version config on the working docs currently conflicts with the recent snapshot's.`, - `Please do 'npm run generate-pixi-version-config' to resolve this accordingly **`, - ); + // Then update the global version configs accordingly + shell.exec('npm run update-global-version-configs'); + + console.log( + `** pixi version config on the working docs currently conflicts with the recent snapshot's.`, + `Please do 'npm run generate-pixi-version-config' to resolve this accordingly **`, + ); + })(); } catch (error) { diff --git a/scripts/generate-pixi-version-config.js b/scripts/generate-pixi-version-config.js index 85e7109eb..fa5138a3e 100644 --- a/scripts/generate-pixi-version-config.js +++ b/scripts/generate-pixi-version-config.js @@ -172,6 +172,19 @@ async function doesVersionConfigExist(version) versionLabel = `v${version}`; } + // Prompt the user to confirm or customize the version label + versionLabel = ( + await inquirer.prompt([ + { + type: 'input', + name: 'versionLabel', + message: 'Confirm or customize the version label:', + default: versionLabel, + validate: (input) => input.trim().length > 0, + }, + ]) + ).versionLabel; + config = { versionLabel, version, diff --git a/scripts/remove-docs-version-snapshot.js b/scripts/remove-docs-version-snapshot.js index 4988c2302..7797d3614 100644 --- a/scripts/remove-docs-version-snapshot.js +++ b/scripts/remove-docs-version-snapshot.js @@ -6,6 +6,11 @@ const inquirer = require('inquirer'); const ROOT = resolve(__dirname, '..'); +function getGenericVersion(version) +{ + return version.replace(/(\d+)(\.\d+)?(\.\d+)?(-.*)?/, '$1.x'); +} + // Find all pixi-version.json files in the versioned docs directory const versionFiles = glob.sync(`${ROOT}/versioned_docs/**/pixi-version.json`); @@ -50,12 +55,20 @@ console.log('Removing a version snapshot of the docs...'); const config = versions.find((version) => version.versionLabel === choice.selected); + /** + * Use the docusaurus versions config to determine if the snapshot is of a generic version, + * so that correct directory and sidebar names can be referred to. + */ + const snapshotVersions = JSON.parse(readFileSync(join(ROOT, 'versions.json'), 'utf8')); + const isGenericSnapshot = !snapshotVersions.includes(config.version); + const key = isGenericSnapshot ? getGenericVersion(config.version) : config.version; + // 1st Confirmation const confirmation = await inquirer.prompt([ { type: 'list', name: 'selected', - message: `Are you sure you want to remove ${config.versionLabel} (v${config.version}) snapshot?`, + message: `Are you sure you want to remove ${config.versionLabel} (v${key}) snapshot?`, choices: ['no', 'yes'], default: 'no', loop: false, @@ -72,11 +85,11 @@ console.log('Removing a version snapshot of the docs...'); { type: 'input', name: 'version', - message: `Please type version number '${config.version}' to remove the snapshot?`, + message: `Please type version number '${key}' to remove the snapshot?`, }, ]); - if (input.version !== config.version) + if (input.version !== key) { shell.exit(0); } @@ -86,11 +99,8 @@ console.log('Removing a version snapshot of the docs...'); // Read versions.json const data = readFileSync(join(ROOT, 'versions.json'), 'utf8'); - // Parse the JSON - let parsed = JSON.parse(data); - // Remove the selected version - parsed = parsed.filter((version) => version !== config.version); + const parsed = snapshotVersions.filter((version) => version !== key); // If there are no versions left, delete versions.json if (!parsed.length) @@ -104,12 +114,12 @@ console.log('Removing a version snapshot of the docs...'); } // Delete the versioned directory - rmSync(join(ROOT, 'versioned_docs', `version-${config.version}`), { recursive: true, force: true }); + rmSync(join(ROOT, 'versioned_docs', `version-${key}`), { recursive: true, force: true }); // Delete the versioned sidebars - rmSync(join(ROOT, 'versioned_sidebars', `version-${config.version}-sidebars.json`), { recursive: true, force: true }); + rmSync(join(ROOT, 'versioned_sidebars', `version-${key}-sidebars.json`), { recursive: true, force: true }); - console.log(`Successfully removed ${config.versionLabel} (v${config.version}) snapshot!`); + console.log(`Successfully removed ${config.versionLabel} (v${key}) snapshot!`); // Then update the global version configs accordingly shell.exec('npm run update-global-version-configs'); diff --git a/scripts/switch-snapshot-pixi-version-config.js b/scripts/switch-snapshot-pixi-version-config.js index b0d1dcf17..d904b1107 100644 --- a/scripts/switch-snapshot-pixi-version-config.js +++ b/scripts/switch-snapshot-pixi-version-config.js @@ -6,6 +6,11 @@ const inquirer = require('inquirer'); const { spawn } = require('child_process'); const ROOT = resolve(__dirname, '..'); +function getGenericVersion(version) +{ + return version.replace(/(\d+)(\.\d+)?(\.\d+)?(-.*)?/, '$1.x'); +} + // Find all pixi-version.json files in the versioned docs directory const versionFiles = glob.sync(`${ROOT}/versioned_docs/**/pixi-version.json`); @@ -50,17 +55,23 @@ console.log('Switching a snapshot\'s pixi version config...'); const config = versions.find((version) => version.versionLabel === choice.selected); + /** + * Use the docusaurus versions config to determine if the snapshot is of a generic version, + * so that correct directory and sidebar names can be referred to. + */ + const snapshotVersions = JSON.parse(readFileSync(join(ROOT, 'versions.json'), 'utf8')); + const isGenericSnapshot = !snapshotVersions.includes(config.version); + const key = isGenericSnapshot ? getGenericVersion(config.version) : config.version; + // Run generate-pixi-version-config script on the selected snapshot directory - const generatePixiVersionConfig = spawn('npm', ['run', 'generate-pixi-version-config', '--', config.version], { + const generatePixiVersionConfig = spawn('npm', ['run', 'generate-pixi-version-config', '--', key], { stdio: 'inherit', }); // Wait for generate-pixi-version-config script to finish generatePixiVersionConfig.on('close', () => { - const newConfig = JSON.parse( - readFileSync(join(ROOT, `versioned_docs/version-${config.version}`, 'pixi-version.json'), 'utf8'), - ); + const newConfig = JSON.parse(readFileSync(join(ROOT, `versioned_docs/version-${key}`, 'pixi-version.json'), 'utf8')); const oldVersion = config.version; const newVersion = newConfig.version; @@ -68,29 +79,34 @@ console.log('Switching a snapshot\'s pixi version config...'); // If version has changed, update versioned docs directory and sidebar name accordingly if (newVersion !== oldVersion) { - // Rename versioned docs directory - shell.mv(join(ROOT, `versioned_docs/version-${oldVersion}`), join(ROOT, `versioned_docs/version-${newVersion}`)); - - // Rename versioned docs sidebar - shell.mv( - join(ROOT, `versioned_sidebars/version-${oldVersion}-sidebars.json`), - join(ROOT, `versioned_sidebars/version-${newVersion}-sidebars.json`), - ); - - // Update version number on versions.json - let parsed = JSON.parse(readFileSync(join(ROOT, 'versions.json'), 'utf8')); - - parsed = parsed.map((version) => + // For specific version snapshots, rename the versioned docs directory and sidebar to match the new version + if (!isGenericSnapshot) { - if (version === oldVersion) + // Rename versioned docs directory + shell.mv( + join(ROOT, `versioned_docs/version-${oldVersion}`), + join(ROOT, `versioned_docs/version-${newVersion}`), + ); + + // Rename versioned docs sidebar + shell.mv( + join(ROOT, `versioned_sidebars/version-${oldVersion}-sidebars.json`), + join(ROOT, `versioned_sidebars/version-${newVersion}-sidebars.json`), + ); + + // Update version number on versions.json + const parsed = snapshotVersions.map((version) => { - version = newVersion; - } + if (version === oldVersion) + { + version = newVersion; + } - return version; - }); + return version; + }); - writeFileSync(join(ROOT, 'versions.json'), JSON.stringify(parsed, null, 2)); + writeFileSync(join(ROOT, 'versions.json'), JSON.stringify(parsed, null, 2)); + } console.log( `Successfully switched snapshot ${config.versionLabel} (v${oldVersion})`, diff --git a/scripts/update-global-version-configs.js b/scripts/update-global-version-configs.js index fdde68c64..34cd8f056 100644 --- a/scripts/update-global-version-configs.js +++ b/scripts/update-global-version-configs.js @@ -1,10 +1,15 @@ -const { writeFileSync, readFileSync } = require('fs'); +const { writeFileSync, readFileSync, existsSync } = require('fs'); const glob = require('glob'); const recast = require('recast'); -const { resolve } = require('path'); +const { join, resolve } = require('path'); const ROOT = resolve(__dirname, '..'); +function getGenericVersion(version) +{ + return version.replace(/(\d+)(\.\d+)?(\.\d+)?(-.*)?/, '$1.x'); +} + console.log('Update docusaurus version config and pixi-versions.json...\n'); // Find all pixi-version.json files @@ -52,6 +57,16 @@ recast.visit(ast, { { prop.value.properties = versions.map((version) => { + /** + * Currently, the only way to know if a snapshot is of a generic version + * is to check if the versioned_docs directory exists. + * If it doesn't exist, then it's a generic snapshot. (eg. 7.x) + * Otherwise, it's a specific snapshot. (eg. 7.3.2) + */ + const versionedDocsDir = join(ROOT, `versioned_docs/version-${version}`); + const isGenericSnapshot = !existsSync(versionedDocsDir); + const key = isGenericSnapshot ? getGenericVersion(version.version) : version.version; + const versionProps = [ recast.types.builders.property( 'init', @@ -66,7 +81,7 @@ recast.visit(ast, { recast.types.builders.property( 'init', recast.types.builders.identifier('path'), - recast.types.builders.literal(version.version), + recast.types.builders.literal(key), ), ); } @@ -86,7 +101,7 @@ recast.visit(ast, { return recast.types.builders.property( 'init', - recast.types.builders.identifier(version.isCurrent ? 'current' : `'${version.version}'`), + recast.types.builders.identifier(version.isCurrent ? 'current' : `'${key}'`), recast.types.builders.objectExpression(versionProps), ); }); diff --git a/src/pages/versions.tsx b/src/pages/versions.tsx index da39bfd5e..2dac2ad7a 100644 --- a/src/pages/versions.tsx +++ b/src/pages/versions.tsx @@ -8,6 +8,8 @@ import Link from '@docusaurus/Link'; import Translate from '@docusaurus/Translate'; import Versions from '@site/pixi-versions.json'; +import LegacyVersions from '@site/legacy-pixi-versions.json'; +import DevVersions from '@site/pixi-dev-versions.json'; import Heading from '@theme/Heading'; import Layout from '@theme/Layout'; import type { IVersion } from '@site/src/components/Playground/PixiPlayground/usePixiVersions'; @@ -31,9 +33,13 @@ export default function Version(): JSX.Element { // TODO: Make it an adaptive version listing instead const versions = Versions as IVersion[]; + const legacyVersions = LegacyVersions as IVersion[]; + const devVersions = DevVersions as IVersion[]; const latestVersion = versions.find((version) => version.latest); const preReleaseVersion = versions.find((version) => version.prerelease); - const pastVersions = versions.filter((version) => !version.latest && !version.prerelease); + const pastVersions = [...versions, ...legacyVersions].filter( + (version) => !version.latest && !version.prerelease && !version.dev, + ); return ( @@ -42,65 +48,95 @@ export default function Version(): JSX.Element PixiJS API documentation versions - {preReleaseVersion && ( + {latestVersion && (
- - Prerelease version + + Current version (Stable)

- - Here you can find the documentation for the prerelease version. + + Here you can find the documentation for current released version.

- + +
{preReleaseVersion.version}{latestVersion.version} - + - + + + + +
)} - {latestVersion && ( +
+ + Next version (Unreleased) + +

+ + Here you can find the documentation for work-in-process unreleased version. + +

+ + + {devVersions.map((version) => ( + + + + + + ))} + +
{version.version} + + + + + + + +
+
+ + {preReleaseVersion && (
- - Current version (Stable) + + Prerelease version

- - Here you can find the documentation for current released version. + + Here you can find the documentation for the prerelease version.

- + -
{latestVersion.version}{preReleaseVersion.version} - + - + - - - -
diff --git a/versioned_docs/version-7.3.3/branding.md b/versioned_docs/version-7.x/branding.md similarity index 100% rename from versioned_docs/version-7.3.3/branding.md rename to versioned_docs/version-7.x/branding.md diff --git a/versioned_docs/version-7.3.3/examples/index.md b/versioned_docs/version-7.x/examples/index.md similarity index 100% rename from versioned_docs/version-7.3.3/examples/index.md rename to versioned_docs/version-7.x/examples/index.md diff --git a/versioned_docs/version-7.3.3/faq.md b/versioned_docs/version-7.x/faq.md similarity index 100% rename from versioned_docs/version-7.3.3/faq.md rename to versioned_docs/version-7.x/faq.md diff --git a/versioned_docs/version-7.3.3/guides/basics/architecture-overview.md b/versioned_docs/version-7.x/guides/basics/architecture-overview.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/basics/architecture-overview.md rename to versioned_docs/version-7.x/guides/basics/architecture-overview.md diff --git a/versioned_docs/version-7.3.3/guides/basics/getting-started.md b/versioned_docs/version-7.x/guides/basics/getting-started.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/basics/getting-started.md rename to versioned_docs/version-7.x/guides/basics/getting-started.md diff --git a/versioned_docs/version-7.3.3/guides/basics/render-loop.md b/versioned_docs/version-7.x/guides/basics/render-loop.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/basics/render-loop.md rename to versioned_docs/version-7.x/guides/basics/render-loop.md diff --git a/versioned_docs/version-7.3.3/guides/basics/scene-graph.md b/versioned_docs/version-7.x/guides/basics/scene-graph.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/basics/scene-graph.md rename to versioned_docs/version-7.x/guides/basics/scene-graph.md diff --git a/versioned_docs/version-7.3.3/guides/basics/what-pixijs-is-not.md b/versioned_docs/version-7.x/guides/basics/what-pixijs-is-not.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/basics/what-pixijs-is-not.md rename to versioned_docs/version-7.x/guides/basics/what-pixijs-is-not.md diff --git a/versioned_docs/version-7.3.3/guides/basics/what-pixijs-is.md b/versioned_docs/version-7.x/guides/basics/what-pixijs-is.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/basics/what-pixijs-is.md rename to versioned_docs/version-7.x/guides/basics/what-pixijs-is.md diff --git a/versioned_docs/version-7.3.3/guides/components/assets.md b/versioned_docs/version-7.x/guides/components/assets.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/assets.md rename to versioned_docs/version-7.x/guides/components/assets.md diff --git a/versioned_docs/version-7.3.3/guides/components/containers.md b/versioned_docs/version-7.x/guides/components/containers.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/containers.md rename to versioned_docs/version-7.x/guides/components/containers.md diff --git a/versioned_docs/version-7.3.3/guides/components/display-object.md b/versioned_docs/version-7.x/guides/components/display-object.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/display-object.md rename to versioned_docs/version-7.x/guides/components/display-object.md diff --git a/versioned_docs/version-7.3.3/guides/components/graphics.md b/versioned_docs/version-7.x/guides/components/graphics.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/graphics.md rename to versioned_docs/version-7.x/guides/components/graphics.md diff --git a/versioned_docs/version-7.3.3/guides/components/interaction.md b/versioned_docs/version-7.x/guides/components/interaction.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/interaction.md rename to versioned_docs/version-7.x/guides/components/interaction.md diff --git a/versioned_docs/version-7.3.3/guides/components/sprite-sheets.md b/versioned_docs/version-7.x/guides/components/sprite-sheets.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/sprite-sheets.md rename to versioned_docs/version-7.x/guides/components/sprite-sheets.md diff --git a/versioned_docs/version-7.3.3/guides/components/sprites.md b/versioned_docs/version-7.x/guides/components/sprites.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/sprites.md rename to versioned_docs/version-7.x/guides/components/sprites.md diff --git a/versioned_docs/version-7.3.3/guides/components/text.md b/versioned_docs/version-7.x/guides/components/text.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/text.md rename to versioned_docs/version-7.x/guides/components/text.md diff --git a/versioned_docs/version-7.3.3/guides/components/textures.md b/versioned_docs/version-7.x/guides/components/textures.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/components/textures.md rename to versioned_docs/version-7.x/guides/components/textures.md diff --git a/versioned_docs/version-7.3.3/guides/index.md b/versioned_docs/version-7.x/guides/index.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/index.md rename to versioned_docs/version-7.x/guides/index.md diff --git a/versioned_docs/version-7.3.3/guides/migrations/upgrading.md b/versioned_docs/version-7.x/guides/migrations/upgrading.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/migrations/upgrading.md rename to versioned_docs/version-7.x/guides/migrations/upgrading.md diff --git a/versioned_docs/version-7.3.3/guides/migrations/v5.md b/versioned_docs/version-7.x/guides/migrations/v5.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/migrations/v5.md rename to versioned_docs/version-7.x/guides/migrations/v5.md diff --git a/versioned_docs/version-7.3.3/guides/migrations/v6.md b/versioned_docs/version-7.x/guides/migrations/v6.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/migrations/v6.md rename to versioned_docs/version-7.x/guides/migrations/v6.md diff --git a/versioned_docs/version-7.3.3/guides/migrations/v7.md b/versioned_docs/version-7.x/guides/migrations/v7.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/migrations/v7.md rename to versioned_docs/version-7.x/guides/migrations/v7.md diff --git a/versioned_docs/version-7.3.3/guides/production/performance-tips.md b/versioned_docs/version-7.x/guides/production/performance-tips.md similarity index 100% rename from versioned_docs/version-7.3.3/guides/production/performance-tips.md rename to versioned_docs/version-7.x/guides/production/performance-tips.md diff --git a/versioned_docs/version-7.3.3/pixi-version.json b/versioned_docs/version-7.x/pixi-version.json similarity index 100% rename from versioned_docs/version-7.3.3/pixi-version.json rename to versioned_docs/version-7.x/pixi-version.json diff --git a/versioned_docs/version-7.3.3/playground/index.md b/versioned_docs/version-7.x/playground/index.md similarity index 100% rename from versioned_docs/version-7.3.3/playground/index.md rename to versioned_docs/version-7.x/playground/index.md diff --git a/versioned_docs/version-7.3.3/tutorials/index.md b/versioned_docs/version-7.x/tutorials/index.md similarity index 100% rename from versioned_docs/version-7.3.3/tutorials/index.md rename to versioned_docs/version-7.x/tutorials/index.md diff --git a/versioned_sidebars/version-7.3.3-sidebars.json b/versioned_sidebars/version-7.x-sidebars.json similarity index 100% rename from versioned_sidebars/version-7.3.3-sidebars.json rename to versioned_sidebars/version-7.x-sidebars.json diff --git a/versions.json b/versions.json index 253786c7d..cbcf51367 100644 --- a/versions.json +++ b/versions.json @@ -1,3 +1,3 @@ [ - "7.3.3" -] + "7.x" +] \ No newline at end of file