Skip to content
This repository was archived by the owner on Jul 16, 2025. It is now read-only.

Commit b2c4485

Browse files
docs: update readme (#147)
Signed-off-by: stefanicjuraj <[email protected]>
1 parent fc5a982 commit b2c4485

File tree

1 file changed

+62
-41
lines changed

1 file changed

+62
-41
lines changed

README.md

Lines changed: 62 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -9,72 +9,93 @@
99

1010
<div align="center">
1111

12+
[![Documentation](https://img.shields.io/github/v/release/daytonaio/docs?label=Docs&color=23cc71)](https://www.daytona.io/docs)
1213
[![License](https://img.shields.io/badge/License-Apache--2.0-blue)](#license)
1314
[![Issues - daytona](https://img.shields.io/github/issues/daytonaio/docs)](https://github.com/daytonaio/docs/issues)
1415

1516
</div>
1617

1718
<h1 align="center">Daytona Documentation</h1>
1819
<div align="center">
19-
Daytona's user and developer documentation.
20+
Daytona user and developer documentation.
2021
</div>
2122
</br>
2223

2324
<p align="center">
24-
<a href="https://github.com/daytonaio/docs/issues/new?assignees=&labels=bug">Report Bug</a>
25+
<a href="https://github.com/daytonaio/docs/issues/new?assignees=&labels=bug">Report Bug</a>
2526
·
2627
<a href="https://go.daytona.io/slack">Join Our Slack</a>
2728
·
28-
<a href="https://twitter.com/daytonaio">Twitter</a>
29-
</p>
29+
<a href="https://twitter.com/daytonaio">Twitter</a>
30+
</p>
3031

31-
<hr/>
32+
The Daytona Documentation is developed with Astro and Starlight.
33+
Its core architecture leverages React, while documentation content is authored using Markdown (MDX).
3234

33-
## Development
35+
## Getting Started
3436

35-
The Daytona Documentation website is built using Astro and Stralight.
36-
The core of the website is built in React, with documentation and other content built in MDX.
37+
### Using Daytona (Recommended)
3738

38-
### Setting up a Development Environment
39-
40-
The easiest way to start working on the documentation is by using a DEM such as Daytona.
41-
You can create a Workspace with the dependencies and configuration needed to preview the docs locally by executing the following command:
39+
The most efficient way to begin working on the documentation is by utilizing a development environment manager (DEM) like Daytona.
40+
To set up a Workspace with the necessary dependencies and configurations for local preview, run the following command:
4241

4342
```shell
4443
daytona create https://github.com/daytonaio/docs.git
4544
```
4645

47-
Alternatively, if your local machine has Node.js and Yarn set up, you can clone this repository and execute `yarn install` to install the required dependencies.
46+
### Manual
47+
48+
Alternatively, if Node.js or Yarn are installed and set up on your local machine, you can clone this repository and install the required dependencies and configurations:
49+
50+
```shell
51+
git clone https://github.com/daytonaio/docs.git
52+
```
53+
54+
```shell
55+
yarn install
56+
```
4857

4958
### Useful Commands
5059

51-
This repository uses Yarn to handle project management.
52-
For convenience, a number of scripts are defined in `package.json` that can be called using Yarn:
53-
54-
| Command | Action |
55-
| :------------------------------ | :------------------------------------------------------------------ |
56-
| `yarn run dev` | Starts local dev server at `localhost:4321` |
57-
| `yarn run build` | Builds your production site to `./dist/` |
58-
| `yarn run preview` | Previews your build locally before deployment |
59-
| `yarn run astro ...` | Runs CLI commands like `astro add`, `astro check` |
60-
| `yarn run astro -- --help` | Provides help for using the Astro CLI |
61-
| `yarn run update-cli-reference` | Update the Daytona CLI reference docs using autogenerated CLI docs` |
62-
63-
### Navigating the Docs
64-
65-
On the filesystem, you'll find the content in `./src/content/docs` in the form of `.mdx` files.
66-
Daytona's documentation is organized into broad topics:
67-
68-
- **Configuration**
69-
Information around configuring the main components of Daytona.
70-
- **About**
71-
Background and conceptual information about Daytona and DEMs.
72-
- **Installation**
73-
Information around installing Daytona under different environments.
74-
- **Reference**
75-
Technical and architectural information about Daytona.
76-
- **Usage**
77-
Practical information on using Daytona.
60+
This repository utilizes `Yarn` to manage project dependencies and custom scripts. Below is a list of commonly used commands, defined in the `package.json`:
61+
62+
| Command | Action |
63+
| :------------------------- | :--------------------------------------------------------------------------- |
64+
| `yarn dev` | Starts the local development server at `localhost:4321`. |
65+
| `yarn build` | Builds the production site to the `./dist/` directory. |
66+
| `yarn preview` | Previews the production build locally before deployment. |
67+
| `yarn astro [command]` | Runs Astro CLI commands. |
68+
| `yarn astro -- --help` | Displays help information for the Astro CLI. |
69+
| `yarn update-cli-reference`| Updates the Daytona CLI reference using autogenerated CLI documentation. |
70+
71+
### Documentation Structure
72+
73+
The documentation is organized as `.mdx` files within the `/src/content/docs` directory.
74+
Daytona documentation is divided into the following key sections:
75+
76+
- **`About`**
77+
78+
Overview of Daytona's background and the concept of development environment manager (DEM).
79+
80+
- **`Installation`**
81+
82+
Instructions for installing Daytona across various environments.
83+
84+
- **`Configuration`**
85+
86+
Guides to configuring Daytona's core components.
87+
88+
- **`Usage`**
89+
90+
Practical instructions for using Daytona.
91+
92+
- **`Reference`**
93+
94+
Detailed technical and architectural documentation for Daytona.
95+
96+
- **`Miscellaneous`**
97+
98+
Additional information and resources related to Daytona.
7899

79100
## Contributing
80101

@@ -101,5 +122,5 @@ This project has adapted the Code of Conduct from the [Contributor Covenant](htt
101122

102123
## Questions
103124

104-
If you need guideance on contributing to Daytona, talk to us on
125+
If you need guidance on contributing to Daytona, talk to us on
105126
[Slack](https://go.daytona.io/slack).

0 commit comments

Comments
 (0)