Skip to content

Rewrite README and document public APIs under src/ - #35

Merged
cschuchardt88 merged 1 commit into
Rapid-Loop:masterfrom
cschuchardt88:docs/readme-and-xml-docs
Jul 23, 2026
Merged

cschuchardt88 merged 1 commit into
Rapid-Loop:masterfrom
cschuchardt88:docs/readme-and-xml-docs

Conversation

@cschuchardt88

@cschuchardt88 cschuchardt88 commented Jul 23, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Rewrites README.md for Rapid Loop positioning: modular Neo C#/.NET platform, package overview, dual-hat clarity (not official Neo Foundation), build/test and contact links.
  • Adds XML documentation comments (///) for public types and members across src/ (Core, VM, Wallet, Configuration, IO, Localization, Hosting, Storage, CLI), including public members on internal helpers where applicable.
  • No intentional logic or signature changes; docs-only source updates.

Test plan

  • dotnet build All.slnx succeeds with 0 warnings / 0 errors
  • Spot-check IntelliSense / generated *.xml docs for a few packages (e.g. Neo.Core, Neo.VM, Neo.Wallet)
  • Confirm README renders correctly on GitHub

Align the project README with Rapid Loop positioning and Neo protocol
compatibility. Document public types and members across src/ so NuGet
XML docs and IntelliSense cover the modular platform packages.

(cherry picked from commit 76718f3)
@cschuchardt88
cschuchardt88 force-pushed the docs/readme-and-xml-docs branch from c761237 to 6c22e09 Compare July 23, 2026 14:21
@cschuchardt88
cschuchardt88 merged commit aa24eb5 into Rapid-Loop:master Jul 23, 2026
4 checks passed
@cschuchardt88
cschuchardt88 deleted the docs/readme-and-xml-docs branch July 23, 2026 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant