Skip to content

Commit 2340aea

Browse files
docs: add index and indexing ignore for docs pub
1 parent e63780b commit 2340aea

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/.indexignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
**/.indexignore
2+
TODO.md
3+
README.md
4+
archive/

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Docs
2+
3+
This directory contains documentation for the project. It includes guides, tutorials, and reference materials to help users understand and utilize the features of the project effectively. The main documentation entry point is [index.md](index.md).

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# FluxGraph Documentation
2+
3+
Welcome to the FluxGraph documentation! FluxGraph is a protocol-agnostic, graph-based physics simulation library for embedded systems.
4+
5+
The documentation is quite rough at the moment, but we are actively working on improving it. We encourage you to explore the available resources using the navbar on the left. If you have any questions or need further assistance, please don't hesitate to reach out in the issues or discussions!

0 commit comments

Comments
 (0)