feat: replace Starlight docs with simple HTML product website
- Removed docs/ (Starlight) - Added www/ with pure HTML/CSS/JS landing page - Product website with features, how it works, get started - Basic HTML documentation pages (installation, quick start, AI providers) - Dockerfile.docs now serves static files from www/ - Updated README and AGENTS.md
This commit is contained in:
29
README.md
29
README.md
@@ -3,7 +3,6 @@
|
||||
Self-hosted AI-powered daily journaling application. Capture events throughout the day and let AI generate thoughtful diary pages from your entries.
|
||||
|
||||
[](https://github.com/lotherk/deardiary)
|
||||
[](https://lotherk.github.io/deardiary)
|
||||
|
||||
## Features
|
||||
|
||||
@@ -33,21 +32,19 @@ cd deardiary
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Access the app at `http://localhost:8080`
|
||||
Access the app at `http://localhost:5173`
|
||||
|
||||
Default credentials: `admin@localhost` / `changeme123`
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation is available at [https://lotherk.github.io/deardiary](https://lotherk.github.io/deardiary)
|
||||
Documentation is included in the `www/` directory. Run the website container:
|
||||
|
||||
Topics covered:
|
||||
- [Installation](https://lotherk.github.io/deardiary/getting-started/installation/)
|
||||
- [Quick Start](https://lotherk.github.io/deardiary/getting-started/quick-start/)
|
||||
- [Configuration](https://lotherk.github.io/deardiary/getting-started/configuration/)
|
||||
- [Features](https://lotherk.github.io/deardiary/features/events/)
|
||||
- [API Reference](https://lotherk.github.io/deardiary/api/authentication/)
|
||||
- [Deployment](https://lotherk.github.io/deardiary/deployment/docker/)
|
||||
```bash
|
||||
docker compose up -d docs
|
||||
```
|
||||
|
||||
Access at `http://localhost:4000`
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -81,14 +78,6 @@ npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Build Docs Locally
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Docker Build
|
||||
|
||||
```bash
|
||||
@@ -106,7 +95,9 @@ docker compose build && docker compose up -d
|
||||
│ ├── pages/ # Page components
|
||||
│ ├── components/
|
||||
│ └── lib/ # API client, geolocation
|
||||
├── docs/ # Starlight documentation site
|
||||
├── www/ # Product website with docs
|
||||
├── Dockerfile # App container
|
||||
├── Dockerfile.docs # Website container
|
||||
└── docker-compose.yml
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user