Skip to content

Alternative approach Improve settings catalog documentation #249

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Alternative approach Improve settings catalog documentation #249

wants to merge 1 commit into from

Conversation

@snodecoder
Copy link
Contributor

@snodecoder snodecoder commented Oct 11, 2025 •
edited
Loading

Pull request related to issue: #242

The main goal was to enrich and improve the readability of the settings catalog documentation for IntuneCD. This PR provides an alternative, simplified approach based on feedback from my first approach in PR #245.

Key Changes:

  • Improved the clarity and readability of settings catalog documentation.
  • Added --enrich-documentation to use the improved settings catalog documentation functionality.
  • Moved the storage of enrichment information to separate files (instead of adding it to backedup jsons)
  • Avoided certain changes from the first approach to keep this PR simpler and easier to review, did not do:
    • HTML table collapses for long values (XML, JSON), instead kept it with MD table syntax.
    • Fixes for decoding value bugs (especially around base64 detection for script content). (I will create a separate issue for this later)

@snodecoder
Alternative approach improve documentation (#12)
e1a8ac0 
Adds --enrich-documentation flag to both backup and documentation commands to enable enhanced Settings Catalog documentation
Implements new documentation functions for handling enriched Settings Catalog configurations with categorization and detailed descriptions
Updates escape_markdown function to preserve URLs while escaping markdown characters in other text
@snodecoder snodecoder marked this pull request as ready for review October 11, 2025 22:46
@snodecoder snodecoder mentioned this pull request Oct 11, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@snodecoder