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

Antora docs initial work #11

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,7 @@ venv/
ENV/
env.bak/
venv.bak/

# Documentation
docs/node_modules
docs/build
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Docs Editing Readme

#### Build and run the documentation

* Run `npm install` to install the dependencies
* Run `npm run docs` to build the directory
* Run `npm run docs:watch` to run the inner docs website
* Open `https://127.0.0.1:8080/` to see the compiled docs

#### Add a new page

* Create a new file at desired destination
* Add your info to the page
* Add a link to the `docs/modules/ROOT/nav.adoc`
8 changes: 8 additions & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: stellar-contracts
title: Stellar Contracts
version: 0.1.0
nav:
- modules/ROOT/nav.adoc
asciidoc:
attributes:
page-sidebar-collapse-default: false
4 changes: 4 additions & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* Token Standards
** xref:tokens/fungible.adoc[Fungible Tokens]


21 changes: 21 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:source-highlighter: highlight.js
:highlightjs-languages: bash

= Stellar Smart Contracts Suite

A comprehensive collection of secure, scalable smart contracts and utilities for the Stellar network, supporting Fungible, Non-Fungible, and Multi-Token standards.

== Token Standards
Explore our implementations for token standards on Stellar Soroban:

- **xref:tokens/fungible.adoc[Fungible Tokens]**: Digital assets representing a fixed or dynamic supply of identical units.
- **Non-Fungible Tokens**: Unique digital assets with verifiable ownership (work in progress).
- **Multi-Token**: Hybrid tokens enabling both fungible and non-fungible token functionalities (work in progress).

== Audits
// TODO: You can find our audit reports here.

== Get Started
// TODO: link to the Wizard


15 changes: 15 additions & 0 deletions docs/modules/ROOT/pages/tokens/fungible.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:source-highlighter: highlight.js
:highlightjs-languages: rust
:github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
= Fungible Token Standard

== Source Code link: // TODO

== Purpose

The Fungible Token Standard is a contract template designed to facilitate the creation and management of fungible tokens on the Stellar network.
It provides a flexible and secure framework for defining and managing token standards, enabling developers to create and manage tokens with ease.

== Extensions
* Mintable: // TODO
* Burnable: // TODO
8 changes: 8 additions & 0 deletions docs/modules/ROOT/templates/token_template.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:source-highlighter: highlight.js
:highlightjs-languages: rust
:github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
= XXX Token Standard

== Purpose

== Extensions
Loading
Loading