Skip to content

Commit

Permalink
docs: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
bob8100 committed Oct 23, 2024
1 parent 9de7848 commit 5582145
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# Bookshop API Documentation

Welcome to the Bookshop API documentation! This project provides comprehensive documentation for the Bookshop API, which allows you to manage books, authors, and other resources in an online bookshop. The documentation is available online at [https://joseph-eccles.github.io/api-docs/](https://joseph-eccles.github.io/api-docs/).
Welcome to the Bookshop API documentation! This project provides comprehensive documentation for the Bookshop API, which allows you to manage books, authors, and other resources in an online bookshop. The documentation is available online at <a href="https://joseph-eccles.github.io/api-docs" target="_blank">joseph-eccles.github.io/api-docs</a>.

## Table of Contents

- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Deployment](#deployment)
- [Docs-as-Code Approach](#docs-as-code-approach)
- [Contributing](#contributing)
- [License](#license)

## Technologies Used

Expand All @@ -19,7 +17,7 @@ The Bookshop API documentation is built using the following technologies:
- **[MDX](https://mdxjs.com/)**: A format that allows writing JSX in Markdown files, making it possible to create interactive and dynamic documentation pages.
- **[Tailwind CSS](https://tailwindcss.com/)**: A utility-first CSS framework that is used to style the documentation site with minimal effort.
- **[GitHub Actions](https://github.com/features/actions)**: Automates the deployment process, ensuring that changes to the documentation are published to GitHub Pages.
- **[GitHub Pages](https://pages.github.com/)**: Hosts the static site for the documentation at [https://joseph-eccles.github.io/api-docs/](https://joseph-eccles.github.io/api-docs/).
- **[GitHub Pages](https://pages.github.com/)**: Hosts the static site for the documentation at [https://joseph-eccles.github.io/api-docs](https://joseph-eccles.github.io/api-docs).

## Getting Started

Expand Down Expand Up @@ -51,15 +49,15 @@ Start the local development server with:

Open http://localhost:3000 in your browser to see the documentation.

4. **_Build the Static Site_**
4. **Build the Static Site**

To generate a static version of the site for deployment, run:

```bash
npm run build
```

5. **_Preview the Production Build_**
5. **Preview the Production Build**

After building, you can preview the production build locally:

Expand All @@ -73,13 +71,13 @@ The documentation is automatically deployed to GitHub Pages using GitHub Actions

### Deployment Steps

1. **_GitHub Actions Workflow:_** The repository contains a .github/workflows/deploy.yml file that defines the deployment process. It builds the static site using Next.js and then deploys it to the gh-pages branch.
2. **_GitHub Pages Configuration:_** The repository is configured to serve the static site from the gh-pages branch. The site is accessible at <a href="https://joseph-eccles.github.io/api-docs" target="_blank"></a>.
1. **GitHub Actions Workflow:** The repository contains a .github/workflows/deploy.yml file that defines the deployment process. It builds the static site using Next.js and then deploys it to the gh-pages branch.
2. **GitHub Pages Configuration:** The repository is configured to serve the static site from the gh-pages branch. The site is accessible at <a href="https://joseph-eccles.github.io/api-docs" target="_blank">joseph-eccles.github.io/api-docs</a>.

## Docs-as-Code Approach

This project follows the Docs-as-Code approach, which means that the documentation is treated as code and maintained in the same way as software code:

- **_Version Control:_** The documentation is stored in a Git repository, allowing for version control, collaboration, and tracking of changes.
- **_Continuous Integration/Continuous Deployment (CI/CD):_** GitHub Actions automates the process of deploying the documentation whenever changes are made to the main branch.
- **_Markdown and MDX Files:_** The documentation is written in Markdown and MDX, which makes it easy to collaborate and contribute using text-based files.
- **Version Control:** The documentation is stored in a Git repository, allowing for version control, collaboration, and tracking of changes.
- **Continuous Integration/Continuous Deployment (CI/CD):** GitHub Actions automates the process of deploying the documentation whenever changes are made to the main branch.
- **Markdown and MDX Files:** The documentation is written in Markdown and MDX, which makes it easy to collaborate and contribute using text-based files.

0 comments on commit 5582145

Please sign in to comment.