doc: update README

[mds1]

Updates the development and release process, adds missing entries to the directory structure, fixes links, and adds a table of contents. Leaving as a draft as we should not merge until we actually have the initial smart contract releases

[coderabbitai]

Walkthrough

Walkthrough

The Optimism project underwent significant improvements, notably in the README.md file. Changes include adding a table of contents, refining documentation links and descriptions, updating the "Good First Issues" link, restructuring directories, providing insights on production releases and the development/release process. Additionally, a specific functional change was made in the packages/contracts-bedrock/lib/lib-keccak subproject by updating the commit hash.

Changes

File Path	Change Summary
README.md	Added table of contents; updated documentation links and descriptions; changed "Good First Issues" link; rearranged and added new directories in structure section; included details on production releases and the development/release process.
packages/contracts-bedrock/lib/lib-keccak	Updated subproject commit hash from 0115edbbc60b5f702392caafc3a142061e6142fa to 59dcbd7b0de1fd00b44f4ce41e99a7f990564d11.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[github-actions]

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[semgrep-app]

Semgrep found 10 sol-style-return-arg-fmt findings:

• packages/contracts-bedrock/scripts/libraries/LibSort.sol: L506, L387, L370, L353, L348, L331, L314, L279, L273, L267

Named return arguments to functions must be appended with an underscore (_)

_{Ignore this finding from sol-style-return-arg-fmt.}

Semgrep found 39 sol-style-notice-over-dev-natspec findings:

• packages/contracts-bedrock/scripts/libraries/LibSort.sol: L622, L581, L535, L497, L484, L476, L468, L457, L449, L439, L433, L427, L421, L415, L409, L403, L397, L391, L386, L369, L352, L347, L330, L313, L308, L303, L283, L277, L271, L265, L260, L255, L233, L221, L214, L64, L51, L44, L16

Prefer @notice over @dev in natspec comments

_{Ignore this finding from sol-style-notice-over-dev-natspec.}

Semgrep found 3 todos_require_linear findings:

• op-service/eth/blob.go: L85, L75
• op-node/rollup/derive/engine_queue.go: L692

Please create a GitHub ticket for this TODO.

_{Ignore this finding from todos_require_linear.}

[github-actions]

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[mds1]

I think there are some useful changes in here, but still waiting on the v1.0.0 contracts release. @maurelian Would you be able to get this PR over the line since it seems you're owning the setup of the contracts release/tag process?

[maurelian]

I think there are some useful changes in here, but still waiting on the v1.0.0 contracts release. @maurelian Would you be able to get this PR over the line since it seems you're owning the setup of the contracts release/tag process?

Yes.

[github-actions]

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[github-actions]

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[mds1]

Marking this as ready for review now that we have the retroactive contract releases:

• op-contracts/v1.2.0
• op-contracts/v1.1.0
• op-contracts/v1.0.0

[trianglesphere]

Two small typographic comments, but contents lgtm

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.42%. Comparing base (34779f7) to head (a0f454c).
Report is 8 commits behind head on develop.

❗ Current head a0f454c differs from pull request most recent head 34acaf2. Consider uploading reports for the commit 34acaf2 to get more accurate results

Additional details and impacted files

@@             Coverage Diff              @@
##           develop    #8731       +/-   ##
============================================
- Coverage    28.73%   16.42%   -12.32%     
============================================
  Files          162      120       -42     
  Lines         7144     5217     -1927     
  Branches      1309     1157      -152     
============================================
- Hits          2053      857     -1196     
+ Misses        4985     4285      -700     
+ Partials       106       75       -31     

Flag	Coverage Δ
cannon-go-tests	?
chain-mon-tests	27.14% <ø> (ø)
common-ts-tests	?
contracts-bedrock-tests	0.62% <ø> (ø)
contracts-ts-tests	12.25% <ø> (ø)
core-utils-tests	?
sdk-next-tests	41.94% <ø> (ø)
sdk-tests	41.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 42 files with indirect coverage changes