Skip to content

Commit d79422a

Browse files
committed
chore: Update docs
1 parent d6ae462 commit d79422a

File tree

6 files changed

+2
-37
lines changed

6 files changed

+2
-37
lines changed

README.md

-10
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
Reactmos is a small project, primarily a conceptual approach, inspired by [Nuxt Layers](https://nuxt.com/docs/getting-started/layers) for React.
44

5-
> [!NOTE]
6-
> This project is a Work In Progress and currently supports only Single Page Applications (SPA).
7-
85
See [documentation](https://reactmos.dev)
96

107
## CLI
@@ -110,10 +107,3 @@ Reactmos also provides the following functions:
110107
1. **`getRoutes`** - Retrieves all registered routes.
111108
2. **`getRoot`** - Returns the `App.tsx` root component.
112109
3. **`getExtras(moduleName)`** - Returns extra configuration in module configs
113-
114-
## Roadmap
115-
116-
- [x] Support for extending routes/pages
117-
- [x] Support for extending the `public` directory
118-
- [x] Share custom configs with other modules
119-
- [ ] Additional extension capabilities?

docs/content/1.getting-started/1.index.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,7 @@ seo:
77
title: Reactmos - Introduction
88
---
99

10-
Reactmos comes from **REACT MOduleS**. The idea is to create SPA applications with React using separate modules. You can progressively expand your application.
11-
12-
::warning
13-
Reactmos is under heavy development. Use with caution. Many things may change
14-
::
10+
Reactmos comes from **REACT MOduleS**. The idea is to create SPA applications with React using separate modules. You can progressively expand your application. You can run each module individually and independently.
1511

1612
For now, these are the implemented features:
1713

@@ -54,9 +50,3 @@ For now, these are the implemented features:
5450
:::
5551
::
5652

57-
## Roadmap
58-
59-
We have planned the following for the future:
60-
61-
- **loadingHTML**: Use a HTML file as a loading screen until the boot proccess finish. This can be overridden by a module.
62-
- Anything else...

docs/content/1.getting-started/2.installation.md

-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ description: Get started with Reactmos.
44
navigation.icon: i-lucide-download
55
---
66

7-
::warning
8-
Reactmos is under heavy development. Use with caution.
9-
::
10-
117
## Quick Start
128

139
You can start a fresh new project with:

docs/content/1.getting-started/3.usage.md

-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ navigation.icon: i-lucide-sliders
66

77
This is only a basic example of what you can achieve with Reactmos, you can tweak it to match your needs.
88

9-
::warning
10-
Reactmos is under heavy development. Use with caution.
11-
::
12-
139
## Configure routes
1410

1511
You can create the Pages components in `src/pages` and configure the route in `src/module.config.ts` as:

docs/content/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ orientation: horizontal
2222
REACT MOduleS - React SPA with modules
2323

2424
#description
25-
**Reactmos is a lightweight framework for building modular React SPAs, making them more manageable and easier to maintain.**
25+
**Reactmos is a lightweight framework for building modular React SPAs, making them more manageable and easier to maintain. You can run each module individually and independently.**
2626

2727
#links
2828
:::u-button

packages/reactmos/README.md

-7
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,3 @@ Reactmos also provides the following functions:
110110
1. **`getRoutes`** - Retrieves all registered routes.
111111
2. **`getRoot`** - Returns the `App.tsx` root component.
112112
3. **`getExtras(moduleName)`** - Returns extra configuration in module configs
113-
114-
## Roadmap
115-
116-
- [x] Support for extending routes/pages
117-
- [x] Support for extending the `public` directory
118-
- [x] Share custom configs with other modules
119-
- [ ] Additional extension capabilities?

0 commit comments

Comments
 (0)