https://github.com/org-foodservice/foodservicewiki

This repository is dedicated to providing all necessary information about the various repositories developed for the FoodService project
https://github.com/org-foodservice/foodservicewiki

docs wiki

Last synced: about 2 months ago
JSON representation

This repository is dedicated to providing all necessary information about the various repositories developed for the FoodService project

• Host: GitHub
• URL: https://github.com/org-foodservice/foodservicewiki
• Owner: Org-FoodService
• Created: 2024-06-07T08:43:54.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T13:30:21.000Z (4 months ago)
• Last Synced: 2024-08-29T20:24:38.736Z (4 months ago)
• Topics: docs, wiki
• Homepage: https://foodservice.gitbook.io/foodservice/
• Size: 915 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 📚 FoodService Documentation

Welcome to the **FoodService** project documentation and wiki repository! This repository is dedicated to providing all necessary information about the various repositories developed for the FoodService project.

## 🎯 Purpose

The purpose of this repository is to centralize all markdown documentation and the project wiki, using the **Gitbook** platform for better organization and accessibility.

## 📖 About Gitbook

[Gitbook](https://www.gitbook.com/) is a modern platform for documentation that allows you to create, manage, and share documentation easily and efficiently. By using Gitbook, we ensure that our documentation is always organized, accessible, and easy to navigate. You can view the complete documentation at: [FoodService Documentation](https://foodservice.gitbook.io/foodservice/).

## 📁 Repository Structure

This repository is organized as follows:

- `wiki/` - Contains all information organized for easy navigation.

- `README.md` - This file, with general instructions and information about the repository.

## 📜 FoodService Project Repositories

### 1. FoodServiceMVC

- **Description**: Web application developed in ASP.NET MVC for the FoodService project.

- **Repository**: [FoodServiceMVC](https://github.com/Org-FoodService/FoodServiceMVC)

### 2. FoodServiceAPI

- **Description**: Backend for the FoodService project, responsible for managing the APIs.

- **Repository**: [FoodServiceAPI](https://github.com/Org-FoodService/FoodServiceAPI)

### 3. FoodServiceModels (NuGet Package)

- **Description**: NuGet package containing the data models used by the FoodServiceMVC and FoodServiceAPI repositories.

- **Repository**: [FoodServiceModels](https://github.com/Org-FoodService/FoodService.Models)

## 🛠️ Maintenance

It is the team's responsibility to keep the documentation always up-to-date. Make sure to review and update the documentation regularly to reflect changes and improvements in the project.

## 📝 Contribution

Contributions are welcome! To contribute, follow these steps:

1. **Develop on Gitbook**: Documentation should be developed directly on the Gitbook platform.

2. **Request Access**: Team members should receive an access link to Gitbook to gain modification permissions.

3. **Update the Documentation**: Ensure that changes are reflected both in Gitbook and the repository structure.

## 📞 Contact

If you have any questions or suggestions, feel free to open an issue or contact the development team.

---

We hope this repository is useful for the development and maintenance of the FoodService project. Thank you for contributing and being part of this project!

👩‍💻👨‍💻 **FoodService Team**