Commit Graph
4 Commits
Author SHA1 Message Date
Mohd KaifandClaude Sonnet 4.6 b282487b17 docs: rewrite and polish documentation site (#413)
- 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:38:21 +05:30
KaifAhmad1 d3b579208c Comprehensive documentation cleanup and improvements
## Documentation Changes

### 📚 Major Improvements
- **Cleaned up all documentation files** - Removed redundant content and improved clarity
- **Restructured Resources section** - Removed unnecessary files, kept only essential ones
- **Added Snowflake integration** - Complete integration guide with examples
- **Improved navigation** - Better organization and user experience

### 🗂️ File Changes
- **docs/concepts.md** - Rewritten to be clean and user-friendly
- **docs/modules.md** - Updated with current modules and removed emojis
- **docs/glossary.md** - Reorganized thematically instead of alphabetically
- **docs/getting-started.md** - Made more concise and practical
- **docs/community.md** - Clean, focused community guide
- **docs/contributing.md** - Clear contribution guidelines
- **docs/faq.md** - Comprehensive FAQ with practical answers
- **docs/license.md** - Clean license explanation
- **docs/css/custom.css** - Fixed CSS syntax and organization

### 🔧 Technical Changes
- **mkdocs.yml** - Updated navigation, removed redundant files
- **docs/integrations/snowflake.md** - New comprehensive Snowflake guide
- **docs/reference/ingest.md** - Added Snowflake references
- **Removed files**: changelog.md, release-guide.md, change_management_usage.md, community-projects.md, architecture.md, governance.md, citation.md

### 🎯 Benefits
- **Better user experience** - Clean, easy to navigate documentation
- **Reduced redundancy** - No duplicate or unnecessary content
- **Professional quality** - Enterprise-ready documentation
- **Consistent style** - Uniform formatting across all files

This commit includes all documentation improvements while maintaining the main branch's stability.
2026-02-05 17:43:16 +05:30
KaifAhmad1 4f66a672fa Comprehensive documentation improvements
- Restructured guides with grid cards and better formatting
- Expanded cookbook to include all 39 use case notebooks
- Streamlined all resource files to be concise
- Removed time estimates throughout documentation
- Fixed broken GitHub links
- Updated version to 0.0.5 and year to 2025
- Improved architecture documentation with Mermaid diagrams
- Enhanced FAQ with plain Q&A format
- Made all documentation consistent and professional
2025-11-29 18:24:26 +05:30
KaifAhmad1 03b84ab238 docs: Add comprehensive open source project improvements
- Add essential open source files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, CHANGELOG.md, CONTRIBUTORS.md)
- Add GitHub issue and PR templates
- Add CI/CD workflows (CI, docs, release, dependabot)
- Add pre-commit hooks configuration
- Add documentation enhancements (architecture, governance, contributing, community)
- Add developer experience scripts (setup-dev, run-tests, format-code, check-code)
- Add community features (SUPPORT.md, .all-contributorsrc)
- Enhance README badges and project metadata
- Update mkdocs.yml navigation structure
2025-11-24 13:30:49 +05:30