Skip to content

Commit

Permalink
resolved potential issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Dhiren-Mhatre committed Dec 31, 2024
1 parent 1468c0f commit 9cc7cb2
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
# Talawa Admin Documentation Website

[![N|Solid](static/img/markdown/misc/logo.png)](https://github.com/PalisadoesFoundation/talawa-admin)
[![N|Solid](static/img/markdown/misc/logo.png)](https://github.com/PalisadoesFoundation/talawa-admin)

# Installation

This document provides instructions on how to set up and start a running instance of the [talawa-admin documentation website](https://docs-admin.talawa.io/) on your local system. The instructions are written to be followed in sequence so make sure to go through each of them step by step without skipping any sections.
This document provides instructions on how to set up and start a running instance of the [talawa-admin documentation website](https://docs-admin.talawa.io/) on your local system. The instructions are written to be followed in sequence so make sure to go through each of them step by step without skipping any sections.

# Table of Contents

<!-- /TOC -->

- [Developer-Docs Installation](#talawa-admin-installation)
- [Developer-Docs Installation](#talawa-admin-installation)
- [Table of Contents](#table-of-contents)
- [Prerequisites for Developers](#prerequisites-for-developers)
Expand All @@ -28,7 +25,6 @@ This document provides instructions on how to set up and start a running instanc

# Prerequisites for Developers

The contents of the `talawa-admin` repo is used to automatically create [the talawa-admin Documentation website](https://docs-admin.talawa.io/). The automation uses [Docusaurus](https://docusaurus.io/docs/), a modern static website generator.
The contents of the `talawa-admin` repo is used to automatically create [the talawa-admin Documentation website](https://docs-admin.talawa.io/). The automation uses [Docusaurus](https://docusaurus.io/docs/), a modern static website generator.

We recommend that you follow these steps before beginning development work in this repository.
Expand All @@ -52,8 +48,6 @@ $ yarn -version
```console
$ git clone https://github.com/PalisadoesFoundation/talawa-admin.git
$ cd talawa-admin
$ git clone https://github.com/PalisadoesFoundation/talawa-admin.git
$ cd talawa-admin
$ yarn add docusaurus
```

Expand Down Expand Up @@ -179,5 +173,4 @@ If you need to generate static HTML pages (unlikely), then follow these steps.
$ yarn run build
```

This command generates static content into the `/build` directory and can be served using any static contents hosting service.

This command generates static content into the `/build` directory and can be served using any static contents hosting service.

0 comments on commit 9cc7cb2

Please sign in to comment.