diff --git a/specs/SUMMARY.md b/specs/SUMMARY.md index 51db9d909..dfc609a11 100644 --- a/specs/SUMMARY.md +++ b/specs/SUMMARY.md @@ -32,7 +32,3 @@ - [Honest Challenger](./experimental/fault-proof/honest-challenger-fdg.md) - [Bond Incentives](./experimental/fault-proof/bond-incentives.md) - [Glossary](./glossary.md) -- [Meta](./meta/index.md) - - [Linting](./meta/linting.md) - - [Versioning](./meta/versioning.md) - - [Markdown Style](./meta/markdown-style.md) diff --git a/specs/meta/index.md b/specs/meta/index.md deleted file mode 100644 index 7ed98dd19..000000000 --- a/specs/meta/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Meta Processes - - - - -This directory describes processes that we use to lint/test the specification. - -- [Markdown Style Guide](markdown-style.md): how to format and structure Markdown files. -- [Versioning](versioning.md) diff --git a/specs/meta/markdown-style.md b/specs/meta/markdown-style.md deleted file mode 100644 index 81ee837c4..000000000 --- a/specs/meta/markdown-style.md +++ /dev/null @@ -1,53 +0,0 @@ -# Markdown Style Guide - - - -**Table of Contents** - -- [Linting](#linting) -- [Links](#links) - - [Glossary](#glossary) -- [Internal (In-File) Links](#internal-in-file-links) - - - -## Linting - -Respect the [linting rules] (you can run the linter with `pnpm lint`). - -Notably: - -- lines should be < 120 characters long - - in practice, some of our files are justified at 100 characters, some at 120 - -[linting rules]: linting.md#markdown - -## Links - -In general: - -- Use link references preferentially. - - e.g. `[my text][link-ref]` and then on its own line `[link-ref]: https://mylink.com` - - e.g. `[my text]` and then on its own line: `[my text]: https://mylink.com` - - exceptions: where it fits neatly on a single line, in particular in lists of links -- Excepted for internal and glossary links (see below), add the link reference definition directly - after the paragraph where the link first appears. - -### Glossary - -- Use links to the [glossary] liberally. -- Include the references to all the glossary links at the top of the file, under the top-level - title. -- A glossary link reference should start with the `g-` prefix. This enables to see what links to the - glossary at a glance when editing the specification. - - e.g. `[g-block]: glossary.md#block` -- Example: [Rollup Node Specification source][rollup-node] - -[glossary]: ../glossary.md -[rollup-node]: https://raw.githubusercontent.com/ethereum-optimism/optimistic-specs/main/specs/rollup-node.md - -## Internal (In-File) Links - -If linking to another heading to the same file, add the link reference directly under that heading. -This makes it easier to keep the heading and the link in-sync, and signals that the heading is being -linked to from elsewhere. diff --git a/specs/meta/versioning.md b/specs/meta/versioning.md deleted file mode 100644 index 381a3a5a3..000000000 --- a/specs/meta/versioning.md +++ /dev/null @@ -1,41 +0,0 @@ -# Versioning - - - -**Table of Contents** - -- [Go modules](#go-modules) - - [versioning process](#versioning-process) -- [Typescript](#typescript) - - - -## Go modules - -Go modules that are currently versioned: - -```text -./op-service -./op-bindings -./op-batcher -./op-node -./op-proposer -./op-e2e -``` - -Go modules which are not yet versioned: - -```text -./indexer (changesets) -./proxyd (changesets) -``` - -### versioning process - -Since changesets versioning is not compatible with Go we are moving away from it. -Starting with new bedrock modules, Go-compatible tags will be used, -formatted as `modulename/vX.Y.Z` where `vX.Y.Z` is semver. - -## Typescript - -See Changesets.