Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a How it works section #1492

Open
5 tasks
ra0x3 opened this issue Dec 4, 2023 · 0 comments
Open
5 tasks

Add a How it works section #1492

ra0x3 opened this issue Dec 4, 2023 · 0 comments
Labels
big documentation Improvements or additions to documentation P: Medium

Comments

@ra0x3
Copy link
Contributor

ra0x3 commented Dec 4, 2023

  • This section would address the following documentation issues:

  • It would be placed below "About" and above "Getting started"

  • This would be a pretty long section with link navigation at the top, and each section broken down with headers and examples

  • Sections should probably be:

    • "At a high level"
      • Brief summary of how every thing works (compilation, deployment, registration, execution, DB interaction)
    • Compilation
      • Describe how indexers are compiled
    • Deployment
      • Describe how indexers are deployed
        • With all of the various options
    • Registration
      • Describe how deployed indexer assets are registered to the service
    • Execution
      • Describe the process of an indexer getting new data and calling handlers on that data
        • Maybe talk about some of the useful/different start args passed to fuel-indexer
    • DB interaction
      • Describe how indexers save data to the database
  • Every section should include minimal functional examples or diagrams of what the section is describing

@ra0x3 ra0x3 added documentation Improvements or additions to documentation P: Medium big labels Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
big documentation Improvements or additions to documentation P: Medium
Projects
None yet
Development

No branches or pull requests

1 participant