Skip to main content

Introduction

Welcome to the official documentation hub for Inky (or Crab-Ink). This site serves as the central knowledge base for the project, covering development resources, API references, and progress updates.

This is an End of Study Project (EIP) developed at Epitech Montpellier.

Audience and Purpose​

This documentation is primarily designed for:

  • Project Team Members: For internal technical references and development guidelines.
  • Epitech Mentors and Teachers: To track project progress, architecture, and technical implementation.

Documentation Structure​

The website is divided into two main sections to separate technical resources from chronological updates:

1. Project Documentation​

Located at docs.inky.top/doc, this section contains the core technical content, organized by:

  • Research & Concepts: Theoretical background and architectural decisions.
  • API Reference: Technical details for interacting with Inky services.
  • General Guides: How-to guides and general project information.

2. Development Blog​

Located at docs.inky.top/blog, this section serves as our project log, featuring:

  • Meeting minutes and summaries.
  • Sprint updates and milestone tracking.

Access and Authentication​

Note: Some external links references within this documentation point to private repositories or resources within our GitHub Organization.

If you encounter an authentication error or require access to specific restricted resources, please contact the development team directly to request authorization.

Automation​

This website is built automatically and continuously synchronized with our source files hosted on GitHub. This ensures that the documentation always reflects the latest state of the project's codebase and research.