Skip to content

Commit 86586bc

Browse files
committed
docs: improvements
1 parent f5e9a41 commit 86586bc

File tree

4 files changed

+47
-43
lines changed

4 files changed

+47
-43
lines changed

README.md

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -55,41 +55,16 @@ git push
5555

5656
Visit [github.com/coderdiaz-studio/cvfolio/pulls](https://github.com/coderdiaz-studio/cvfolio/pulls) and create a pull request.
5757

58-
## 🚀 Project Structure
58+
## Check our Documentation
5959

60-
Inside of your Astro project, you'll see the following folders and files:
60+
Here is a list of documentation for more in depth information about the cvfolio.
6161

62-
```text
63-
/
64-
├── public/
65-
├── src/
66-
│ └── pages/
67-
│ └── index.astro
68-
└── package.json
69-
```
70-
71-
Astro looks for `.astro` or `.md`, `.mdx` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
72-
73-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
74-
75-
Any static assets, like images, can be placed in the `public/` directory.
76-
77-
## Documentation
78-
List of documentation [Here](/docs/docs.md)
79-
80-
## 🧞 Commands
81-
82-
All commands are run from the root of the project, from a terminal:
83-
84-
| Command | Action |
85-
| :-------------------- | :----------------------------------------------- |
86-
| `bun install` | Installs dependencies |
87-
| `bun dev` | Starts local dev server at `localhost:4321` |
88-
| `bun build` | Build your production site to `./dist/` |
89-
| `bun preview` | Preview your build locally, before deploying |
90-
| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
91-
| `bun astro -- --help` | Get help using the Astro CLI |
62+
| Documentation | Link |
63+
| ----------------------------- | ----------------------------------------------------------------------------------- |
64+
| Project Structure | [docs/project-structure](/docs/project-structure.md) |
65+
| Customization | [docs/customization](/docs/customization.md) |
66+
| How to deploy on GitHub Pages | [docs/guides/how-to-deploy-github-pages](docs/guides/how-to-deploy-github-pages.md) |
9267

93-
## 👀 Want to learn more?
68+
Feel free to add more documentation.
9469

95-
Feel free to check [Astro documentation](https://docs.astro.build).
70+
If you have any comments or recommendations contact me vía [X](https://x.com/coderdiaz) or email [hey(at)coderdiaz.com](mailto:hey@coderdiaz.com), or write an Issue with your proposal.

docs/docs.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/project-structure.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## 🚀 Project Structure
2+
3+
Inside of your Astro project, you'll see the following folders and files:
4+
5+
```text
6+
/
7+
├── public/
8+
├── src/
9+
│ └── pages/
10+
│ └── index.astro
11+
└── package.json
12+
```
13+
14+
Astro looks for `.astro` or `.md`, `.mdx` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
15+
16+
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
17+
18+
Any static assets, like images, can be placed in the `public/` directory.
19+
20+
## Documentation
21+
List of documentation [Here](/docs/docs.md)
22+
23+
## 🧞 Commands
24+
25+
All commands are run from the root of the project, from a terminal:
26+
27+
| Command | Action |
28+
| :-------------------- | :----------------------------------------------- |
29+
| `bun install` | Installs dependencies |
30+
| `bun dev` | Starts local dev server at `localhost:4321` |
31+
| `bun build` | Build your production site to `./dist/` |
32+
| `bun preview` | Preview your build locally, before deploying |
33+
| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
34+
| `bun astro -- --help` | Get help using the Astro CLI |
35+
36+
## 👀 Want to learn more?
37+
38+
Feel free to check [Astro documentation](https://docs.astro.build).

0 commit comments

Comments
 (0)