Skip to content

Commit

Permalink
feat: change project name to optimism-java
Browse files Browse the repository at this point in the history
  • Loading branch information
fearlessfe committed Aug 17, 2024
1 parent b770042 commit 52a9c25
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 218 deletions.
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug-report.yml

This file was deleted.

5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

56 changes: 0 additions & 56 deletions .github/ISSUE_TEMPLATE/partner-contribution.yml

This file was deleted.

40 changes: 8 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,35 @@
# 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

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
Expand Down
82 changes: 8 additions & 74 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -74,14 +73,6 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// announcementBar: {
// id: "announcement_bar",
// content:
// '📣 <strong>Linea ENS</strong> is now available! Visit the <a href="https://names.linea.build/" target="blank">app</a>, <a href="https://support.linea.build/general/ens" target="blank">user guide</a>, or our <a href="https://docs.linea.build/developers/tooling/cross-chain/ccip-read-gateway" target="blank">developer guidance</a> on reusing its architecture.',
// backgroundColor: "#61dfff",
// textColor: "#121212",
// isCloseable: false,
// },
colorMode: {
defaultMode: "dark",
disableSwitch: false,
Expand Down Expand Up @@ -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",
Expand All @@ -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",
// },
],
},
Expand All @@ -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",
// },
],
},
{
Expand Down Expand Up @@ -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: [
{
Expand Down
9 changes: 0 additions & 9 deletions mlc_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
}

4 changes: 2 additions & 2 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "doc.linea",
"name": "optimism-java",
"version": "3.0.0",
"private": true,
"scripts": {
Expand Down
5 changes: 0 additions & 5 deletions project-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -425,11 +425,6 @@ lifecycles
lifescore
lightchaindata
lighthouserc
linea
Lineabridge
lineabuild
lineascan
Lineaster
linenums
linkify
litepaper
Expand Down

0 comments on commit 52a9c25

Please sign in to comment.