Skip to content

Commit

Permalink
Created a documentation skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
Tiger-Tom committed Dec 8, 2023
1 parent 92376b4 commit a1cae07
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/basic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# to be added later
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Basic usage
[basic.md](./basic.md)

## Automatically generated API documentation
[autodocs/RunServer.md](./autodocs/RunServer.md)

## Plugin documentation & examples
[plugins/plugins.md](./plugins/plugins.md)

## Manifest documentation
[manifest/manifest.md](./manifest/manifest.md)
4 changes: 4 additions & 0 deletions docs/manifest/manifest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Manifest documentation
## to be added later

![(outdated) Diagram of what pieces make up a manifest](manifest.svg)
12 changes: 12 additions & 0 deletions docs/plugins/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Plugin documentation

## Usage

### to be added later

## Development

### to be added later

### Examples
See [examples/](./examples/) and [/_rsplugins/1000-builtin/](/_rsplugins/1000-builtin/) for examples

0 comments on commit a1cae07

Please sign in to comment.