Skip to content

Add use cases, privacy docs, and Chinese translations#184

Merged
Ki-Seki merged 5 commits into
mainfrom
docs/use-cases
Jun 1, 2026
Merged

Add use cases, privacy docs, and Chinese translations#184
Ki-Seki merged 5 commits into
mainfrom
docs/use-cases

Conversation

@Ki-Seki
Copy link
Copy Markdown
Member

@Ki-Seki Ki-Seki commented May 30, 2026

Summary

  • Add Use Cases page with 7 real-world information extraction examples (contact extraction, NER, text classification, event extraction, relation extraction, resume parsing, product review analysis)
  • Add Privacy & PII Protection page with 5 privacy-focused examples (PII extraction, redaction, risk classification, safe upload filter for agent memory, mixed content separation)
  • Add Chinese translations for all docs pages
  • Set up mkdocs-static-i18n for native language switching (English / 中文)
  • Update README to highlight use cases and information extraction positioning
  • Update pyproject.toml description and keywords

Test plan

  • Verify docs build: make docs-serve
  • Check English pages render correctly
  • Check Chinese pages render correctly at /zh/
  • Verify language switcher works
  • Verify all code examples are syntactically correct

- Add Use Cases page with 7 real-world information extraction examples
  (contact extraction, NER, text classification, event extraction,
  relation extraction, resume parsing, product review analysis)
- Add Privacy & PII Protection page with 5 privacy-focused examples
  (PII extraction, redaction, risk classification, safe upload filter,
  mixed content separation)
- Add Chinese translations for all docs pages (index, installation,
  quickstart, usage, use cases, privacy)
- Set up mkdocs-static-i18n for native language switching (en/zh)
- Update README to highlight use cases and information extraction focus
- Update pyproject.toml description and keywords
@codecov
Copy link
Copy Markdown

codecov Bot commented May 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 1, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://SculptAI.github.io/GIMKit/pr-preview/pr-184/

Built to branch gh-pages at 2026-06-01 08:49 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Ki-Seki added 2 commits June 1, 2026 16:32
- Add unsafe argument to YAML pre-commit hooks
- Update links in README for use cases
- Remove JSON output type section from model usage documentation
- Modify vLLM offline client examples for clarity
- Delete outdated privacy documentation
- Clean up navigation in mkdocs.yml
@Ki-Seki Ki-Seki marked this pull request as ready for review June 1, 2026 08:43
@Ki-Seki Ki-Seki merged commit 917ebd1 into main Jun 1, 2026
17 checks passed
@Ki-Seki Ki-Seki deleted the docs/use-cases branch June 1, 2026 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant