Add high-level documentation

https://nostr-ruby.com
This commit is contained in:
Wilson Silva
2023-11-13 17:42:07 +07:00
parent b206f6504e
commit d49fac49b6
23 changed files with 1014 additions and 256 deletions

View File

@@ -4,22 +4,41 @@ layout: home
hero:
name: "Nostr"
text: "Ruby gem documentation"
tagline: My great project tagline
text: "Ruby"
tagline: "The Nostr protocol implemented in a Ruby gem."
actions:
- theme: brand
text: Markdown Examples
link: /markdown-examples
text: Getting Started
link: /getting-started/overview
- theme: alt
text: API Examples
link: /api-examples
text: View on Github
link: https://github.com/wilsonsilva/nostr
- theme: alt
text: View on RubyDoc
link: https://www.rubydoc.info/gems/nostr
- theme: alt
text: View on RubyGems
link: https://rubygems.org/gems/nostr
features:
- title: Feature A
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature B
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Asynchronous
details: Non-blocking I/O for maximum performance.
icon: ⚡
- title: Lightweight
details: Minimal runtime dependencies.
icon: 🪶
- title: Intuitive
details: The API mirrors the Nostr protocol specification domain language.
icon: 💡
- title: Fully documented
details: All code is documented from both the maintainer's as well as the consumer's perspective.
icon: 📚
- title: Fully tested
details: All code is tested with 100% coverage.
icon: 🧪
- title: Fully typed
details: All code is typed with <a href="https://rubygems.org/gems/rbs" target="_blank">RBS</a> with the help of <a href="https://rubygems.org/gems/typeprof" target="_blank">TypeProf</a>. Type correctness is enforced by <a href="https://rubygems.org/gems/steep" target="_blank">Steep</a>.
icon: ✅
---