Reference ingest library case-studies aka CDP hackathon projects

Open
#1,330 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript
Domain
documentation

Research direction

Start by reviewing the existing stellar-docs structure and the listed CDP hackathon projects, then locate each project's repository. Define a consistent minimal format covering background, how the ingest library was used or adapted, and an external repository link. Done means the selected projects have concise case-study entries without requiring in-depth write-ups for all of them.

Written by the indexing model from the issue text.

Description

bot:needs-decision documentation help wanted ingest

Each of the CDP-based hackathon projects likely used the ingest library in some fashion (or ported a minimal version of it to a different language). We could reference these in docs as more complex case-studies or examples that showcase the power of using the ingest library.

Project list:

  • JS ingest / "backendless" service
  • CDP-backed RPC
  • Smart Safe
  • Trade aggregations service
  • Biased validator detection service
  • Fraud detection service
  • Payment indexer
  • Contract data indexer
  • etc etc

We might not want to clog up the docs with in-depth write-ups on all of these, as it could turn into a ton of content. But at a minimum, some minimal framing/background for each and linking out to their respective git repos would be valuable. If we decide to go more in-depth, the assignee of this ticket is free to delegate the content pieces to the respective owners of each example.

Dominant language
MDX
Stars
138
Forks
313
Avg merge
3d 11h
Merged PRs (30d)
44

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.

More from stellar/stellar-docs

All issues in stellar/stellar-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.