Skip to content

Updated readme.md #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated readme.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 8 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1,12 @@
# Wordpress Engineering Handbook based on Astro + Starlight
![Travelopia Logo](https://raw.githubusercontent.com/Travelopia/wordpress-engineering-handbook/99615309358a8fb97b40889fea3ecdf2ed6d17dd/src/assets/images/travelopia-logo.svg "Travelopia")

## 🚀 Project Structure
# Wordpress Engineering Handbook
> This handbook serves as a comprehensive resource for engineers at Travelopia. It provides guidelines, best practices, and essential information for various engineering processes and systems.

Inside you'll see the following folders and files:
[Check out Handbook 📖](https://wordpress-handbook.travelopia.com/)

```
.
├── public/
├── src/
│ ├── assets/
├── css/
├── images/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```
# How to Use This Handbook
This handbook is designed to be a living document. We encourage you to use the table of contents to quickly find the information you need. If you cannot find what you're looking for, please reach out to the engineering handbook maintainers.

Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |


## Steps to add a new guide.

1. Create a new `.mdx` file in the `src/content/docs/` directory.
2. Add the [frontmatter]([frontmatter](https://starlight.astro.build/reference/frontmatter/)) to the top of the file. Here is an example:
```md
---
title: "New Guide"
description: "This is a new guide"
template: doc # This is the template for the guide, you can use `doc` or `splash`
---
```
3. Add the content to the file.
4. (Optional) Add the link to the guide in the `src/content/docs/index.mdx` file.
5. Update the listing in `astro.config.mjs` to include the new guide.

## 👀 Want to learn more?

Check out [Starlight’s docs](https://starlight.astro.build/) or read [the Astro documentation](https://docs.astro.build).
# Contributing to the Handbook
We welcome contributions to improve the handbook. If you have suggestions, corrections, or new content to add, please submit a pull request or create an issue on the handbook's repository. Please refer to our [Contributing Guidelines](https://github.com/Travelopia/wordpress-engineering-handbook/blob/main/contributing.md) for detailed instructions.