Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs revamp #1500

Merged
merged 5 commits into from
Dec 29, 2024
Merged

Docs revamp #1500

merged 5 commits into from
Dec 29, 2024

Conversation

omri374
Copy link
Contributor

@omri374 omri374 commented Dec 26, 2024

Docs:

  • Reorganized the navigation structure based on docs of similar packages. The new structure is the following:
 - Presidio: 
    - Home
    - Installation
    - FAQ
 - Quick start: 
    - Home
    - Text
    - Images
    - Semi/Structured data
 - Learn Presidio:
      - Home
      - Concepts
      - Tutorial
      - Text de-identification
          - Home
          - Presidio Analyzer
          - Presidio Anonymizer
      - Image de-identification
      - Structured and Semi-structured
      - PII detection evaluation
 - Resources:
      - Supported entities
      - Community
      - Change log
      - Setting up a development environment
      - Build and release process
      - Changes from V1 to V2
      - Python API reference
      - REST API reference
   - Samples:
     - ... 
  • Added new sections: concepts, evaluation, quick starts (with very simple guidelines)
  • Fixed docstrings issues in packages
  • Fixed typos across the docs
  • Updated tutorial and added a notebook on no-code configuration
  • Added a missing notebook on ner model configuration
  • Samples are now part of the nav

Live version: https://omri374.github.io/presidio/

@omri374 omri374 marked this pull request as ready for review December 29, 2024 06:37
@omri374 omri374 requested a review from Copilot December 29, 2024 06:37

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 33 out of 48 changed files in this pull request and generated no comments.

Files not reviewed (15)
  • docs/api/structured_python.md: Evaluated as low risk
  • docs/faq.md: Evaluated as low risk
  • docs/evaluation/index.md: Evaluated as low risk
  • docs/community.md: Evaluated as low risk
  • docs/anonymizer/index.md: Evaluated as low risk
  • docs/api.md: Evaluated as low risk
  • docs/api/analyzer_python.md: Evaluated as low risk
  • docs/api/anonymizer_python.md: Evaluated as low risk
  • docs/analyzer/customizing_nlp_models.md: Evaluated as low risk
  • docs/analyzer/developing_recognizers.md: Evaluated as low risk
  • docs/image-redactor/index.md: Evaluated as low risk
  • docs/analyzer/nlp_engines/transformers.md: Evaluated as low risk
  • docs/anonymizer/adding_operators.md: Evaluated as low risk
  • CONTRIBUTING.md: Evaluated as low risk
  • docs/getting_started.md: Evaluated as low risk
@omri374
Copy link
Contributor Author

omri374 commented Dec 29, 2024

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@omri374 omri374 merged commit bed2979 into main Dec 29, 2024
32 checks passed
@omri374 omri374 deleted the omri/mkdkocs_updates branch December 29, 2024 11:16
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.

2 participants