Le Hoang Nam
7dc995dcd9
- Created a new Docusaurus project for documentation. - Added configuration file `docusaurus.config.ts` for site settings and theme. - Established initial documentation structure with overview and GitFlow sections. - Included a `.gitignore` file to exclude unnecessary files and directories. - Added essential files such as `package.json`, `package-lock.json`, and initial CSS styles. - Removed outdated guides related to Gitea and Jenkins management.
30 lines
917 B
Markdown
30 lines
917 B
Markdown
# Research Notes Documentation
|
|
|
|
This project serves as a centralized knowledge base for organizing research notes, technical findings, and supporting documentation related to internal development tools and workflows.
|
|
|
|
Built using [Docusaurus](https://docusaurus.io/), it provides a clean, navigable structure for maintaining and accessing information over time.
|
|
|
|
## Getting Started
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://gitea.plp19.com/dev-public/doc-research-notes.git
|
|
cd doc-research-notes
|
|
```
|
|
2. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
3. Start the development server:
|
|
```bash
|
|
npm start
|
|
```
|
|
4. Open the browser and navigate to `http://localhost:3000` to view the documentation.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
|
|
## License
|
|
|
|
This project is internal and proprietary. Do not distribute outside the organization. |