Skip to content

Commit 4b96369

Browse files
committed
feat(readme): add simple readme to mimir
1 parent d077824 commit 4b96369

File tree

3 files changed

+48
-42
lines changed

3 files changed

+48
-42
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
1-
# MIMIR
2-
AI compatible web3 tools
1+
# Mimir
2+
3+
Web3 tools and documentation platform for the Cardano ecosystem.
4+
5+
## Applications
6+
7+
**Mesh Documentation Platform** (`apps/docs`)
8+
- MeshJS documentation site built with Next.js and Fumadocs
9+
- AI Chat functionality
10+
- Includes llms.txt
11+
12+
**Mesh AI** (`apps/mesh-ai` & `apps/mesh.ai.chat-main`)
13+
- Discord bot for community knowledge management
14+
- Question answering from community interactions
15+
16+
**RAG System** (`apps/mesh-rag-ai`)
17+
- RAG system for discord bot in TS
18+
19+
**Starter Site** (`apps/mesh-startersite`)
20+
- Application for onboarding non Web3 developers.
21+
22+
**RAG Backend** (`meshjs-rag`)
23+
- Python based contextual RAG system

apps/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Apps
2+
3+
This folder contains all applications in the Mimir monorepo.
4+
5+
## Applications
6+
7+
- **docs** - Documentation platform for MeshJS built with Next.js and Fumadocs
8+
- **mesh-ai** - Discord bot interface for AI-powered community assistance
9+
- **mesh-rag-ai** - Retrieval-Augmented Generation system for discord bot
10+
- **mesh-startersite** - Application for onboarding non Web3 developers.
11+
- **mesh.ai.chat-main** - Discord bot for community knowledge management
12+
- **meshjs-rag** - Python backend contextual RAG system which powers chat functionality on the meshjs website

apps/docs/README.md

Lines changed: 13 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,18 @@
1-
# meshjs-docs
1+
# MeshJS Documentation
22

3-
This is a Next.js application generated with
4-
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
3+
Documentation platform for MeshJS built with Next.js and Fumadocs.
54

6-
Run development server:
5+
## Structure
76

8-
```bash
9-
npm run dev
10-
# or
11-
pnpm dev
12-
# or
13-
yarn dev
14-
```
7+
- `app/(home)` - Landing page
8+
- `app/docs` - Documentation layout and pages
9+
- `app/api/search` - Search functionality
10+
- `lib/source.ts` - Content source adapter
11+
- `content/docs/` - MDX documentation files
12+
- `components/` - Reusable React components
1513

16-
Open http://localhost:3000 with your browser to see the result.
14+
## Features
1715

18-
## Explore
19-
20-
In the project, you can see:
21-
22-
- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
23-
- `app/layout.config.tsx`: Shared options for layouts, optional but preferred to keep.
24-
25-
| Route | Description |
26-
| ------------------------- | ------------------------------------------------------ |
27-
| `app/(home)` | The route group for your landing page and other pages. |
28-
| `app/docs` | The documentation layout and pages. |
29-
| `app/api/search/route.ts` | The Route Handler for search. |
30-
31-
### Fumadocs MDX
32-
33-
A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
34-
35-
Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
36-
37-
## Learn More
38-
39-
To learn more about Next.js and Fumadocs, take a look at the following
40-
resources:
41-
42-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
43-
features and API.
44-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
45-
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs
16+
- Up-to-date documentation
17+
- AI-powered search and assistance
18+
- llms.txt file for AI code editors

0 commit comments

Comments
 (0)