mirror of https://github.com/semantica-agi/semantica.git synced 2026-08-29 04:26:20 +00:00

Files

T

KaifAhmad1andClaude Sonnet 4.6 129edaf05b docs: rewrite and polish documentation site

- Rewrote index.md to match README (tagline, badges, Problem/Solution text)
- Improved getting-started, concepts, quickstart, installation, faq, use-cases, contributing, glossary, learning-more, examples, modules, architecture, cookbook, deep-dive pages: tighter prose, fixed headings/bullets, removed inconsistencies and duplicate sections
- Removed overuse of emojis from headings in integration pages (docling, snowflake)
- Fixed change_management reference page: closed unclosed JSON code block that broke the right TOC, demoted noisy sub-headings to bold text
- CSS layout: widened content area (max-width 1440px grid, left sidebar 11rem, right TOC narrowed to 11rem for broader content), tightened TOC spacing and font size, fixed word-wrap/overflow on TOC links
- Added mkdocs_local.yml for local serving without mkdocs-jupyter plugin

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-03-26 18:31:39 +05:30

2.2 KiB

Raw Blame History

Contributing

Contributions of all kinds are welcome — code, documentation, tests, and community support.

Quick Start

# Fork the repo, then:
git clone https://github.com/your-username/semantica.git
cd semantica
pip install -e ".[dev]"
pytest

First time? Look for good-first-issue labels for beginner-friendly tasks.

Ways to Contribute

Code

Fix bugs and resolve open issues
Implement new features or integrations
Optimize performance or refactor existing code

Documentation

Fix typos, improve clarity, add examples
Write tutorials or domain-specific cookbook notebooks
Keep API reference up to date

Testing

Add test coverage for untested modules
Reproduce and confirm reported bugs
Improve test reliability

Community

Answer questions in issues and discussions
Review pull requests
Share Semantica in your blog posts or talks

Reporting Issues

Bug Reports

Include: what happened, steps to reproduce, expected behavior, and your environment (Python version, OS, Semantica version).

Feature Requests

Include: your use case, what you'd like Semantica to do, and how it benefits others.

Pull Request Guidelines

Before submitting:

Tests pass locally (pytest)
New features are documented with examples
Code follows project style (Black, isort, flake8)
Commit messages are clear and descriptive
No unresolved merge conflicts

Development Setup

git clone https://github.com/your-username/semantica.git
cd semantica
pip install -e ".[dev]"

Code style tools used: Black (formatting), isort (imports), flake8 (linting).

Run the full test suite:

pytest

Community

Please follow the Code of Conduct. Be respectful, patient, and constructive.

All contributors are recognized in release notes and the GitHub contributors list.

2.2 KiB Raw Blame History