Socle-Commun Documentation

Welcome to the repository of the official Socle-Commun site.

This site aims to centralize all information, standards, tools, and projects related to the Socle-Commun organization.

Site Content

• 🢀 Home: Quick presentation of the organization.
• ðŸ©à Development Conventions: Coding standards, best practices, Git process.
• 💰 Projects: Individual documentation for each affiliated GitHub project.
• ðŸŒ� Public Resources: Shared resources, images, documents.
• ðŸŒ� Internationalization*: English pages (under construction).

Tech Stack

• VitePress for static site generation.
• Markdown (.md) for writing content.
• GitHub Pages for hosting.

Project Structure

vitepress/          # VitePress configuration (config.mts), theme/)
src
  |- index.md       # Home page
  |- conventions/    # Folder for development conventions
  |- projects/        # Folder for project documentation
  |- en-US/        # English version (WIP)
  |- public/         # Public resources
.gitignore        # Ignored files
package.json       # npm dependencies and scripts
package-lock.json     # Locked versions for npm

How to Contribute

We welcome contributions!

1. Fork this repository.
2. Create your branch: git checkout -bf feature/my-contribution
3. Make your changes (respecting conventions).
4. Submit a clear and detailed Pull Request.

Useful Links

• Socle-Commun GitHub Organization
• Official Site

Tags

documentation open-source vitepress github-pages socle-commun