onflow / onflow/docs

[DOCS] CapabilityControllers lack documentation and notice that the feat. isn't yet on Mainnet

Open
#168 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation improvement
Dominant language
TypeScript
Stars
13
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Issue to be solved

Currently, there's a lack of documentation around Capability Controllers, and mention of them labels the existing Capability API as deprecated. A developer following this guidance would be frustrated to realize that the feature isn't yet supported on Mainnet.

Suggest A Solution

Distinguish CapCons API as yet to be enabled on Mainnet and add a notice about the proposed migration plan once enabled.

What are you currently working on that this is blocking?

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation references to Capability Controllers, CapCons API, and the deprecated Capability API. Update the relevant guidance to state that the feature is not enabled on Mainnet and include the proposed migration plan; done when developers can distinguish the current API from the planned migration.

Written by the indexing model from the issue text.

Assessment

Tech stack
blockchain
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.