Documentation Updates

[martindale]

Changes to documentation for release in RC1.

[coderabbitai]

Warning

Rate limit exceeded

@martindale has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 40 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 55 minutes and 40 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 77af9707-fd0c-4f04-bad6-60a8354ab754

📥 Commits

Reviewing files that changed from the base of the PR and between 21ff49d and 1f9c72d.

⛔ Files ignored due to path filters (115)

• assets/examples/agents.html is excluded by !assets/**
• assets/examples/bitcoin.html is excluded by !assets/**
• assets/examples/chain.html is excluded by !assets/**
• assets/examples/fabric.html is excluded by !assets/**
• assets/examples/game.html is excluded by !assets/**
• assets/examples/heartbeat.html is excluded by !assets/**
• assets/examples/index.html is excluded by !assets/**
• assets/examples/message.html is excluded by !assets/**
• assets/examples/relay.html is excluded by !assets/**
• assets/examples/service.html is excluded by !assets/**
• assets/examples/swarm.html is excluded by !assets/**
• docs/Actor.html is excluded by !docs/**
• docs/Bitcoin.html is excluded by !docs/**
• docs/Bond.html is excluded by !docs/**
• docs/CLI.html is excluded by !docs/**
• docs/Chain.html is excluded by !docs/**
• docs/Channel.html is excluded by !docs/**
• docs/Circuit.html is excluded by !docs/**
• docs/Collection.html is excluded by !docs/**
• docs/Contract.html is excluded by !docs/**
• docs/Disk.html is excluded by !docs/**
• docs/Entity.Transition.html is excluded by !docs/**
• docs/Entity.html is excluded by !docs/**
• docs/Environment.html is excluded by !docs/**
• docs/Fabric.html is excluded by !docs/**
• docs/Federation.html is excluded by !docs/**
• docs/Filesystem.html is excluded by !docs/**
• docs/HKDF.html is excluded by !docs/**
• docs/Hash256.html is excluded by !docs/**
• docs/Identity.html is excluded by !docs/**
• docs/Interface.html is excluded by !docs/**
• docs/Key.html is excluded by !docs/**
• docs/Ledger.html is excluded by !docs/**
• docs/Lightning.html is excluded by !docs/**
• docs/Logger.html is excluded by !docs/**
• docs/Machine.html is excluded by !docs/**
• docs/Message.html is excluded by !docs/**
• docs/Peer.html is excluded by !docs/**
• docs/Reader.html is excluded by !docs/**
• docs/Redis.html is excluded by !docs/**
• docs/Remote.html is excluded by !docs/**
• docs/Resource.html is excluded by !docs/**
• docs/RoundRobin.html is excluded by !docs/**
• docs/Scribe.html is excluded by !docs/**
• docs/Script.html is excluded by !docs/**
• docs/Service.html is excluded by !docs/**
• docs/Session.html is excluded by !docs/**
• docs/State.html is excluded by !docs/**
• docs/Store.html is excluded by !docs/**
• docs/Token.html is excluded by !docs/**
• docs/Tree.html is excluded by !docs/**
• docs/Vector.html is excluded by !docs/**
• docs/Wallet.html is excluded by !docs/**
• docs/Worker.html is excluded by !docs/**
• docs/ZMQ.html is excluded by !docs/**
• docs/global.html is excluded by !docs/**
• docs/global.html#Text is excluded by !docs/**
• docs/index.html is excluded by !docs/**
• docs/services_bitcoin.js.html is excluded by !docs/**
• docs/services_lightning.js.html is excluded by !docs/**
• docs/services_redis.js.html is excluded by !docs/**
• docs/services_text.js.html is excluded by !docs/**
• docs/services_txt.js.html is excluded by !docs/**
• docs/services_zmq.js.html is excluded by !docs/**
• docs/settings_deprecations.js.html is excluded by !docs/**
• docs/types_actor.js.html is excluded by !docs/**
• docs/types_bond.js.html is excluded by !docs/**
• docs/types_chain.js.html is excluded by !docs/**
• docs/types_channel.js.html is excluded by !docs/**
• docs/types_circuit.js.html is excluded by !docs/**
• docs/types_cli.js.html is excluded by !docs/**
• docs/types_collection.js.html is excluded by !docs/**
• docs/types_compiler.js.html is excluded by !docs/**
• docs/types_contract.js.html is excluded by !docs/**
• docs/types_datastore.js.html is excluded by !docs/**
• docs/types_disk.js.html is excluded by !docs/**
• docs/types_distributedExecution.js.html is excluded by !docs/**
• docs/types_document.js.html is excluded by !docs/**
• docs/types_ecc.selftest.js.html is excluded by !docs/**
• docs/types_entity.js.html is excluded by !docs/**
• docs/types_environment.js.html is excluded by !docs/**
• docs/types_fabric.js.html is excluded by !docs/**
• docs/types_federation.js.html is excluded by !docs/**
• docs/types_filesystem.js.html is excluded by !docs/**
• docs/types_hash256.js.html is excluded by !docs/**
• docs/types_hkdf.js.html is excluded by !docs/**
• docs/types_identity.js.html is excluded by !docs/**
• docs/types_interface.js.html is excluded by !docs/**
• docs/types_key.js.html is excluded by !docs/**
• docs/types_ledger.js.html is excluded by !docs/**
• docs/types_logger.js.html is excluded by !docs/**
• docs/types_machine.js.html is excluded by !docs/**
• docs/types_message.js.html is excluded by !docs/**
• docs/types_node.js.html is excluded by !docs/**
• docs/types_oracle.js.html is excluded by !docs/**
• docs/types_path.js.html is excluded by !docs/**
• docs/types_peer.js.html is excluded by !docs/**
• docs/types_reader.js.html is excluded by !docs/**
• docs/types_remote.js.html is excluded by !docs/**
• docs/types_resource.js.html is excluded by !docs/**
• docs/types_roundRobin.js.html is excluded by !docs/**
• docs/types_router.js.html is excluded by !docs/**
• docs/types_scribe.js.html is excluded by !docs/**
• docs/types_script.js.html is excluded by !docs/**
• docs/types_service.js.html is excluded by !docs/**
• docs/types_session.js.html is excluded by !docs/**
• docs/types_state.js.html is excluded by !docs/**
• docs/types_store.js.html is excluded by !docs/**
• docs/types_token.js.html is excluded by !docs/**
• docs/types_tree.js.html is excluded by !docs/**
• docs/types_vector.js.html is excluded by !docs/**
• docs/types_wallet.js.html is excluded by !docs/**
• docs/types_witness.js.html is excluded by !docs/**
• docs/types_worker.js.html is excluded by !docs/**
• reports/install.log is excluded by !**/*.log

📒 Files selected for processing (2)

• API.md
• reports/TODO.txt

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codacy-production]

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

_{NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes. Give us feedback}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.39%. Comparing base (21ff49d) to head (1f9c72d).

Additional details and impacted files

@@                 Coverage Diff                 @@
##           feature/v0.1.0-RC1     #180   +/-   ##
===================================================
  Coverage               86.39%   86.39%           
===================================================
  Files                      85       85           
  Lines                   24442    24442           
  Branches                    1        1           
===================================================
  Hits                    21116    21116           
  Misses                   3326     3326           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.