From 52a9c257e7c68fd99eb4d24642d61b3a1da7fd4b Mon Sep 17 00:00:00 2001
From: fearlessfe <505380967@qq.com>
Date: Sat, 17 Aug 2024 11:04:49 +0800
Subject: [PATCH] feat: change project name to optimism-java
---
.github/ISSUE_TEMPLATE/bug-report.yml | 34 --------
.github/ISSUE_TEMPLATE/config.yml | 5 --
.../ISSUE_TEMPLATE/partner-contribution.yml | 56 -------------
README.md | 40 ++-------
docusaurus.config.js | 82 ++-----------------
mlc_config.json | 9 --
package-lock.json | 4 +-
package.json | 2 +-
project-words.txt | 5 --
9 files changed, 19 insertions(+), 218 deletions(-)
delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml
delete mode 100644 .github/ISSUE_TEMPLATE/config.yml
delete mode 100644 .github/ISSUE_TEMPLATE/partner-contribution.yml
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
deleted file mode 100644
index 5c09a37..0000000
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-name: Bug Report
-description: Create a report to help us improve
-labels: ['bug']
-body:
- - type: textarea
- id: issue-description
- attributes:
- label: Describe the bug
- description: A clear and concise description of what the bug is.
- placeholder: Describe the bug here.
- validations:
- required: true
- - type: textarea
- id: issue-reproduction
- attributes:
- label: Steps to reproduce
- description: Describe steps to reproduce the behavior.
- placeholder: Steps to reproduce the bug here.
- validations:
- required: true
- - type: textarea
- id: expected-behavior
- attributes:
- label: Expected behavior
- description: A clear and concise description of what you expected to happen.
- placeholder: Expected behavior here.
- validations:
- required: true
- - type: textarea
- id: screenshots
- attributes:
- label: Screenshots
- description: If applicable, add screenshots to help explain your problem.
- placeholder: Add screenshots here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
deleted file mode 100644
index 5cb1a69..0000000
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ /dev/null
@@ -1,5 +0,0 @@
-blank_issues_enabled: false
-contact_links:
- - name: Linea
- url: https://community.linea.build/
- about: Discuss with the Linea community
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/partner-contribution.yml b/.github/ISSUE_TEMPLATE/partner-contribution.yml
deleted file mode 100644
index f6e74dd..0000000
--- a/.github/ISSUE_TEMPLATE/partner-contribution.yml
+++ /dev/null
@@ -1,56 +0,0 @@
-name: I'm an ecosystem contributor
-description: If you're a protocol, dapp, or other ecosystem organization, submit your issue here
-labels: ['ecosystem']
-body:
- - type: textarea
- id: organization
- attributes:
- label: Organization
- description: Name of the organization.
- placeholder: Enter your organization's name
- validations:
- required: true
- - type: textarea
- id: contributor-name
- attributes:
- label: Contributor name/alias
- description: Provide the name or alias of the contributor.
- placeholder: Enter the name or alias
- validations:
- required: false
- - type: textarea
- id: contributor-affiliation
- attributes:
- label: Affiliation to organization
- description: Provide the contributor's affiliation to the organization.
- placeholder: Enter the affiliation
- validations:
- required: false
- - type: textarea
- id: contributor-role
- attributes:
- label: Contributor role
- description: Provide the role of the contributor (if applicable).
- placeholder: Enter the role
- validations:
- required: false
- - type: checkboxes
- id: nature-of-issue
- attributes:
- label: Nature of issue
- description: Select the type(s) of issue you are reporting.
- options:
- - label: Add documentation about our product
- required: false
- - label: Improve or update existing documentation
- required: false
- - label: Correct errors
- required: false
- - label: Other (please specify below:)
- required: false
- - type: textarea
- id: specify-other
- attributes:
- label: Specify Other
- description: If you selected "Other", please specify.
- placeholder: Specify other issue here.
diff --git a/README.md b/README.md
index 35f339f..5f95adf 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,20 @@
-# Linea documentation
+# Optimism Java documentation
-[Linea](https://linea.build/) is a developer-ready layer 2 network, scaling Ethereum by providing
-an Ethereum-equivalent environment in which to execute transactions, which are then submitted to
-Ethereum Mainnet through a zero-knowledge rollup.
+Optimism Java is a organization which contribute public goods to help the Ethereum and Optimism community get better and better.
This documentation repository is built using [Docusaurus](https://docusaurus.io/), and the site
-itself is published at [`docs.linea.build`](https://docs.linea.build/).
+itself is published at [`optimism-java.github.io`](https://optimism-java.github.io/).
See [more](https://docs-template.consensys.net/) information about how Consensys uses Docusaurus.
## Contribute to the docs
-See something missing? Error in our documentation? Create an issue [here](https://github.com/Consensys/doc.linea/issues).
+See something missing? Error in our documentation? Create an issue [here](https://github.com/optimism-java/optimism-java.github.io).
-Alternatively, help us improve our documentation! [Fork our repo](https://github.com/ConsenSys/doc.linea/fork),
+Alternatively, help us improve our documentation! [Fork our repo](https://github.com/optimism-java/optimism-java.github.io/fork),
create a pull request, and tag us for review! (for help on this, see [below](#how-to-submit-a-suggestion-or-change)).
-Take a look at some [good first issues](https://github.com/ConsenSys/doc.linea/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+Take a look at some [good first issues](https://github.com/optimism-java/optimism-java.github.io?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
to get started.
### How to submit a suggestion or change
@@ -24,36 +22,14 @@ to get started.
The best way to suggest a change to these docs is through a process known as a **pull request**.
If you're not familiar with how that works, check out [GitHub's guide here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
-If you do intend to submit a pull request, please open an issue first, and [link to it in your pull request](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). **This is particularly important if you are an ecosystem contributor** —
-submitting your details in an issue first will make it much easier for our docs team to process your
+If you do intend to submit a pull request, please open an issue first, and [link to it in your pull request](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). **This is particularly important if you are an ecosystem contributor** — submitting your details in an issue first will make it much easier for our docs team to process your
contributions.
-If that process is too involved for you, you can always open a thread on the [Community forum](https://community.linea.build/),
-or a ticket on the [Support page](https://support.linea.build/hc/en-us).
+
If you are familiar with making a pull request, we **highly recommend that you run a version of these docs locally, and preview your changes locally, before submitting them**.
In fact, it's part of the PR process.
-### Contribute to community tutorials
-
-If you've created fleshed-out guides and tutorials, or intend to, we'd love to feature your content
-in our [community tutorials section](developers/guides/community).
-
-First, create an issue describing the content you want to see added or intend to add. If you're
-representing an organization (such as a dapp), please use the ecosystem contribution issue form.
-
-When you're ready to start work, [fork our repo](https://github.com/Consensys/doc.linea/fork),
-create a pull request, and tag us for review!
-
-### Contribute to the Zero-Knowledge Glossary
-
-Diving into zero-knowledge rollups and getting stumped by the technical jargon? We've started an
-open source Zero-Knowledge glossary to define some common terms you might encounter as you dive
-into the L2 landscape.
-
-[Fork our repo](https://github.com/Consensys/doc.linea/fork), and add a term in alphabetical
-order to `docs/reference/glossary.md`. Then, make a pull request and tag us for review!
-
### Additional Resources
View the [Consensys doc contribution guidelines](https://docs-template.consensys.net/) for
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 84f53b9..39ebf2a 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -8,14 +8,13 @@ const katex = require("rehype-katex");
// const baseUrl = isDev ? "/" : "/";
// const organizationName = "Consensys";
-// const projectName = "doc.linea";
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Optimism Java",
// tagline:
//"An EVM-equivalent network, scaling the Ethereum experience. Secured with a zero-knowledge rollup to Ethereum, built on lattice-based cryptography, and powered by Consensys.",
- url: "https://docs.linea.build",
+ url: "https://optimism-java.github.io/",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
@@ -74,14 +73,6 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
- // announcementBar: {
- // id: "announcement_bar",
- // content:
- // '📣 Linea ENS is now available! Visit the app, user guide, or our developer guidance on reusing its architecture.',
- // backgroundColor: "#61dfff",
- // textColor: "#121212",
- // isCloseable: false,
- // },
colorMode: {
defaultMode: "dark",
disableSwitch: false,
@@ -117,49 +108,6 @@ const config = {
position: "left",
label: "Op-Besu",
},
- // {
- // type: "doc",
- // docId: "users/index",
- // position: "left",
- // label: "Users",
- // },
- // {
- // type: "doc",
- // docId: "developers/quickstart/index",
- // position: "left",
- // label: "Developers",
- // },
- // {
- // type: "doc",
- // docId: "architecture/index",
- // position: "left",
- // label: "Architecture",
- // },
- // { can add this section back if we want it
- // type: "dropdown",
- // label: "Tutorials",
- // position: "left",
- // items: [
- // {
- // label: "Community Guides",
- // to: "blog",
- // },
- // {
- // label: "ZK Glossary",
- // to: "/zero-knowledge-glossary",
- // },
- // ],
- // },
- // {
- // to: "/developers/guides/run-a-node",
- // position: "left",
- // label: "Run a node",
- // },
- // {
- // to: "/developers/linea-version",
- // position: "right",
- // label: "Release notes",
- // },
{
href: "https://discord.gg/qHK3Vj4j",
className: "header-discord-link",
@@ -178,21 +126,17 @@ const config = {
{
title: "Links",
items: [
- // {
- // label: "Linea homepage",
- // href: "https://linea.build/",
- // },
- // {
- // label: "Network status",
- // href: "https://linea.statuspage.io/",
- // },
+ {
+ label: "homepage",
+ href: "https://optimism-java.github.io/",
+ },
// {
// label: "Dispute Game mainnet block explorer",
- // href: "https://lineascan.build",
+ // href: "https://todo.build",
// },
// {
// label: "Dispute Game Sepolia block explorer",
- // href: "https://sepolia.lineascan.build",
+ // href: "https://sepolia.todo.build",
// },
],
},
@@ -203,14 +147,6 @@ const config = {
label: "Join our Discord",
href: "https://discord.gg/qHK3Vj4j",
},
- // {
- // label: "Get support",
- // to: "https://support.linea.build/",
- // },
- // {
- // label: "Give feedback",
- // to: "https://community.linea.build/c/feedback",
- // },
],
},
{
@@ -239,9 +175,7 @@ const config = {
],
},
metadata: [
- { name: "twitter:card", content: "summary_large_image" },
- { name: "twitter:image", content: "/img/Linea_social_card_docs.png" },
- { property: "og:image", content: "/img/Linea_social_card_docs.png" },
+ { name: "twitter:card", content: "summary_large_image" }
],
languageTabs: [
{
diff --git a/mlc_config.json b/mlc_config.json
index 3aa3a65..626f3ee 100644
--- a/mlc_config.json
+++ b/mlc_config.json
@@ -9,18 +9,9 @@
{
"pattern": "https://support.metamask.io/"
},
- {
- "pattern": "https://infura.io/faucet/linea"
- },
- {
- "pattern": "https://www.infura.io/faucet/linea"
- },
{
"pattern": "https://infura.io"
}
- {
- "pattern": "https://rpc.sepolia.linea.build"
- }
]
}
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index bc96fc6..169756c 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,11 +1,11 @@
{
- "name": "doc.linea",
+ "name": "optimism-java",
"version": "3.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
- "name": "doc.linea",
+ "name": "optimism-java",
"version": "3.0.0",
"dependencies": {
"@docusaurus/core": "^3.4.0",
diff --git a/package.json b/package.json
index 94a70e9..fc48cdf 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
{
- "name": "doc.linea",
+ "name": "optimism-java",
"version": "3.0.0",
"private": true,
"scripts": {
diff --git a/project-words.txt b/project-words.txt
index 36b56b6..ca61c69 100644
--- a/project-words.txt
+++ b/project-words.txt
@@ -425,11 +425,6 @@ lifecycles
lifescore
lightchaindata
lighthouserc
-linea
-Lineabridge
-lineabuild
-lineascan
-Lineaster
linenums
linkify
litepaper