Skip to content

Commit 4396e04

Browse files
committed
home page begin
1 parent ea23159 commit 4396e04

File tree

3 files changed

+9
-36
lines changed

3 files changed

+9
-36
lines changed

docs/index.md

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,9 @@
1-
# Welcome to MkDocs 3
1+
# Welcome to OmniPackage
22

3-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
3+
## Architecture overview
44

5-
## Commands
5+
There are 2 main components:
66

7-
* `mkdocs new [dir-name]` - Create a new project.
8-
* `mkdocs serve` - Start the live-reloading docs server.
9-
* `mkdocs build` - Build the documentation site.
10-
* `mkdocs -h` - Print help message and exit.
7+
1. [Agent](https://github.com/omnipackage/omnipackage-agent-ruby) - responsible for building packages. Can be used as stand-alone or as a build agent connected to the server-side
8+
2. [Server-side aka web](https://github.com/omnipackage/omnipackage-web) - responsible for web UI, package signing and repositories management. Managed version [web.omnipackage.org](https://web.omnipackage.org). Can be [self-hosted](self_hosting.md)
119

12-
## Project layout
13-
14-
mkdocs.yml # The configuration file.
15-
docs/
16-
index.md # The documentation homepage.
17-
... # Other markdown pages, images and other files.
18-
19-
20-
``` mermaid
21-
sequenceDiagram
22-
autonumber
23-
Alice->>John: Hello John, how are you?
24-
loop Healthcheck
25-
John->>John: Fight against hypochondria
26-
end
27-
Note right of John: Rational thoughts!
28-
John-->>Alice: Great!
29-
John->>Bob: How about you?
30-
Bob-->>John: Jolly good!
31-
```
32-
33-
``` mermaid
34-
graph LR
35-
A[Start] --> B{Error?};
36-
B -->|Yes| C[Hmm...];
37-
C --> D[Debug];
38-
D --> B;
39-
B ---->|No| E[Yay!];
40-
```

docs/self_hosting.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Self-hosting OmniPackage web
2+
3+
WIP

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ site_author: "Oleg Antonyan"
88
nav:
99
- Home: index.md
1010
- 'Getting started': getting_started.md
11+
- 'Self-hosting': self_hosting.md
1112
- About: about.md
1213

1314

0 commit comments

Comments
 (0)