Skip to content

vdappdev2/verus-pbaas-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Verus PBaaS Documentation

Comprehensive documentation for the Verus PBaaS system, built using the Diátaxis framework (Tutorials, How-to Guides, Concepts, Reference).

Status

Early draft. Documentation is being built bottom-up from live RPC testing on vrsctest. Pages are verified against daemon behavior, not copied from existing sources.

Structure

docs/
  reference/        — RPC command reference (parameters, return values, examples)
  concepts/         — Explanations of how Verus systems work
  how-to/           — Task-oriented guides for specific goals
  tutorials/        — Learning-oriented walkthroughs (coming soon)

Current coverage

  • Identity — 11 RPC reference pages, 4 concept pages, 3 how-to guides
  • Marketplace — 5 RPC reference pages, 2 concept pages, 1 how-to guide
  • Multichain — 2 RPC reference pages, 2 concept pages, 1 how-to guide
  • Data — 7 RPC reference pages, 2 concept pages, 5 how-to guides

Methodology

All documentation is built bottom-up:

  1. Test each RPC command live on vrsctest
  2. Document parameters, behavior, edge cases with real output
  3. Extract into presentable pages separated by Diátaxis quadrant
  4. Claims are backed by verified daemon behavior

About

Documentation for Verus PBaaS using Diataxis framework

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors