Add plugins docs outline #1560
Add plugins docs outline #1560
Conversation
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
| description: Create a Linea plugin. | ||
| --- | ||
|
|
||
| # Create a Linea plugin |
There was a problem hiding this comment.
do we want to walk the user through creating the sequencer? This seems difficult. Or do we envision this as more of a walkthrough on how it was accomplished, and not asking much of the user? One thing we could do is also use an example from each of Linea's modified areas in the plug-in. I.e. walk through tx pool changes, block validation changes, creation limits, more, and only discuss one area. E.g. Modify x in the tx pool (step 1), modify y in block validation (Step 2). Only going through one example per area.
There was a problem hiding this comment.
If it's necessary to discuss the Linea plugin in the docs, then yes maybe the latter would be helpful. If the goal is to help users learn how to create a plugin from scratch, we could first focus on a simpler use case that would be easier to create an end-to-end tutorial for? I.e., the tutorial that would go in Get started > Create a simple plugin.
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
|
@non-fungible-nelson I raised several doc issues tagged "plugins" for the topics outlined in this PR: https://github.com/hyperledger/besu-docs/issues?q=is%3Aissue+is%3Aopen+label%3Aplugins – The only one missing is a topic related to the Linea plugins. I think the next step is to get developer input on some of these topics, especially the tutorials/walkthroughs and API reference. Then once we have a couple essential pages ready, we can publish a limited version of these docs as we continue to fill out the topics from the outline. How does that sound? |
|
Sounds good to me! I will slot this into our backlog for devs, and ping when I know more! |
|
@alexandratran we do plan to pick this up and fill in the blanks |
Add new "Plugins" docs section with outline of topics and content needed.
Preview: https://besu-docs-kw18py8zq-hyperledger.vercel.app/plugins