Skip to content

Commit

Permalink
fix: links to old docs
Browse files Browse the repository at this point in the history
  • Loading branch information
smartcontracts committed Aug 15, 2024
1 parent 1e36d58 commit f6e413d
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 50 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Optimism Docs
# Optimism Community Hub

This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo.
This repo houses the Optimism Community Hub located at [community.optimism.io](https://community.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo.

## Local Development

Expand All @@ -16,7 +16,7 @@ Please see the [CONTRIBUTING.md](CONTRIBUTING.md) page for specifics on how to w

## Project Board

You can track documentation [issues](https://github.com/ethereum-optimism/docs/issues) or submit documentation [requests](https://github.com/ethereum-optimism/docs/issues/new/choose) directly from this repo.
You can track documentation [issues](https://github.com/ethereum-optimism/community-hub/issues) or submit documentation [requests](https://github.com/ethereum-optimism/community-hub/issues/new/choose) directly from this repo.

## License

Expand Down
2 changes: 1 addition & 1 deletion pages/404.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ description: 404 page not found and directs users to submit an git issue.

## Let's find our way back. <br /> Visit the [homepage](index) to get started.

#### Please help by [submitting an issue](https://github.com/ethereum-optimism/docs/issues/new/choose) for the broken link. ❤️
#### Please help by [submitting an issue](https://github.com/ethereum-optimism/community-hub/issues/new/choose) for the broken link. ❤️

2 changes: 1 addition & 1 deletion pages/500.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ description: 500 internal server error and directs users to submit an git issue.

## Something isn't quite right. Let's start again on the [homepage](index).

#### Please help by [submitting an issue](https://github.com/ethereum-optimism/docs/issues/new/choose) about what led you to this page. ❤️
#### Please help by [submitting an issue](https://github.com/ethereum-optimism/community-hub/issues/new/choose) about what led you to this page. ❤️
2 changes: 1 addition & 1 deletion pages/contribute/contribution-path/technerds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can also see the [Slides for the TechNERD](https://docs.google.com/presentat
| Lesson | Topic | Exercise | Link |
|:-------|:------|:---------|:-----|
| 1 | Getting an RPC Endpoint | Get an RPC endpoint. You will need this for all following exercises. | [Provider Options](https://docs.optimism.io/builders/tools/connect/rpc-providers) |
| 2 | Run an OP Goerli Node | Most developer questions we get are about running a node. Pay special attention to any issues you face or confusion you have. This can take up to 2 weeks (depending on your internet speed) to sync. | [Run a Node](https://community.optimism.io/docs/developers/build/run-a-node/) |
| 2 | Run an OP Goerli Node | Most developer questions we get are about running a node. Pay special attention to any issues you face or confusion you have. This can take up to 2 weeks (depending on your internet speed) to sync. | [Run a Node](https://docs.optimism.io/builders/node-operators/rollup-node) |
| 3 | Setting up an OP Stack | The OP Stack is an incredible step towards the Superchain vision. As such you should be familiar with the standard OP Stack. | [Getting Started with the OP Stack](https://docs.optimism.io/stack/getting-started)
| 4 | Setting up an explorer for your OP Stack | Make your OP Stack feel more real with its own block explorer! | [Blockscout explorer guide](https://docs.optimism.io/builders/chain-operators/tools/explorer)
| 5 | Deploy & bridge a standard ERC20 | As an L2, bridging is a pretty important concept. Make sure you are comfortable with the bridging process. | [Standard Bridge, Standard Token](https://github.com/ethereum-optimism/optimism-tutorial/tree/main/standard-bridge-standard-token) |
Expand Down
2 changes: 1 addition & 1 deletion patches/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ index 602dc3851aa1c8499a8c5ae2d810d5e4ee8e87a9..5dd03a2ea17272b8779341ecfd73e2df
if (frontmatter?.type === 'yaml') {
await validateFrontmatter(frontmatter, vFile, settings);
+ } else {
+ // Specific logic for the ethereum-optimism/docs repository. We
+ // Specific logic for the ethereum-optimism/community-hub repository. We
+ // always want to have a frontmatter section. Working on getting
+ // this fixed in the upstream plugin so we don't need this hack.
+ throw new Error('Missing frontmatter')
Expand Down
80 changes: 41 additions & 39 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions public/service-worker.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Script exists to clear the service worker cache from the old website. Please keep this script
// around until we're confident that users have the latest version of the site. Since Next doesn't
// use service workers it should be safe to keep this around indefinitely if needed.

self.addEventListener('install', (event) => {
// Force the service worker to take control immediately
self.skipWaiting()
Expand Down
6 changes: 3 additions & 3 deletions theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ const config: DocsThemeConfig = {
),
darkMode: true,
project: {
link: 'https://github.com/ethereum-optimism/docs',
link: 'https://github.com/ethereum-optimism/community-hub',
},
docsRepositoryBase: 'https://github.com/ethereum-optimism/docs/blob/main/',
docsRepositoryBase: 'https://github.com/ethereum-optimism/community-hub/blob/main/',
footer: {
text: 'OP Documentation',
},
Expand Down Expand Up @@ -66,7 +66,7 @@ const config: DocsThemeConfig = {
const { asPath, defaultLocale, locale } = useRouter()
const { frontMatter } = useConfig()
const url =
'https://docs.optimism.io' +
'https://community.optimism.io' +
(defaultLocale === locale ? asPath : `/${locale}${asPath}`)

return (
Expand Down
2 changes: 1 addition & 1 deletion utils/plugins/remark/remark-lint-no-blocked-characters.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { lintRule } from 'unified-lint-rule'
*/
const remarkLintNoBlockedCharacters = lintRule(
{
url: 'https://github.com/ethereum-optimism/docs',
url: 'https://github.com/ethereum-optimism/community-hub',
origin: 'remark-lint:no-blocked-characters'
},
(tree, file) => {
Expand Down

0 comments on commit f6e413d

Please sign in to comment.