Skip to content

Commit

Permalink
chore: update links legacy documentation and packages (#1992)
Browse files Browse the repository at this point in the history
* Update legacy docs

* Update legacy package documents links

* Update edit path for legacy site

* Revert "Update legacy package documents links"

This reverts commit 4da6edc.

* Revert package updates
  • Loading branch information
josephfusco authored Nov 26, 2024
1 parent 25cf3a0 commit b098fcb
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions internal/legacy.faustjs.org/docs/next/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Please install our Next.js Getting Started example using the following command:

```bash
npx create-next-app \
-e https://github.com/wpengine/faustjs/tree/main \
-e https://github.com/wpengine/faustjs/tree/archive-legacy \
--example-path examples/next/getting-started \
--use-npm \
my-app
Expand All @@ -24,7 +24,7 @@ cd my-app

```ps
npx create-next-app `
-e https://github.com/wpengine/faustjs/tree/main `
-e https://github.com/wpengine/faustjs/tree/archive-legacy `
--example-path examples/next/getting-started `
--use-npm `
my-app && cd my-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ FAUSTWP_SECRET_KEY=xxxx

### Ensure you've created your `faust.config.js` file and are importing it in your `_app.tsx`

Like the [`next/getting-started`](https://github.com/wpengine/faustjs/tree/main/examples/next/getting-started) Faust.js example, your [`faust.config.js`](https://github.com/wpengine/faustjs/blob/main/examples/next/getting-started/src/faust.config.js) file will live in the `src` directory.
Like the [`next/getting-started`](https://github.com/wpengine/faustjs/tree/archive-legacy/examples/next/getting-started) Faust.js example, your [`faust.config.js`](https://github.com/wpengine/faustjs/blob/main/examples/next/getting-started/src/faust.config.js) file will live in the `src` directory.

You'll need to import it at the top of your `_app.tsx` file to ensure the `config` is set, and your Faust.js app initializes appropriately.

Expand Down
2 changes: 1 addition & 1 deletion internal/legacy.faustjs.org/docs/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export default coreConfig({

**Notice**: `headlessConfig` has been renamed to just `config`

[Take a look at the Getting Started example for a closer look at these breaking changes.](https://github.com/wpengine/faustjs/tree/main/examples/next/getting-started)
[Take a look at the Getting Started example for a closer look at these breaking changes.](https://github.com/wpengine/faustjs/tree/archive-legacy/examples/next/getting-started)

### Faust.js 0.11.0 - Sept 23, 2021

Expand Down
2 changes: 1 addition & 1 deletion internal/legacy.faustjs.org/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ module.exports = {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl:
'https://github.com/wpengine/faustjs/edit/canary/internal/legacy.faustjs.org/',
'https://github.com/wpengine/faustjs/edit/archive-legacy/internal/legacy.faustjs.org/',
showLastUpdateAuthor: true,
showLastUpdateTime: true,
},
Expand Down

0 comments on commit b098fcb

Please sign in to comment.