Skip to content

docs: CLAUDE.md governance cleanup#85

Merged
joshsmithxrm merged 7 commits intodevelopfrom
docs/cleanup-staging
Jan 15, 2026
Merged

docs: CLAUDE.md governance cleanup#85
joshsmithxrm merged 7 commits intodevelopfrom
docs/cleanup-staging

Conversation

@joshsmithxrm
Copy link
Owner

Summary

  • Trim CLAUDE.md to <100 lines per governance rules
  • Move strategy documentation to staging area
  • Include solution syncs from Dev environment

Test plan

  • Verify CLAUDE.md is <100 lines
  • Verify solution imports correctly

🤖 Generated with Claude Code

joshsmithxrm and others added 2 commits January 13, 2026 22:44
Move strategy documentation to ppdsw/Projects/PPDS/DocsCleanup
for consolidation. This content may later be migrated to ppds-docs.

Files moved:
- docs/strategy/ALM_OVERVIEW.md
- docs/strategy/BRANCHING_STRATEGY.md
- docs/strategy/ENVIRONMENT_STRATEGY.md
- docs/strategy/PIPELINE_STRATEGY.md
- docs/strategy/CROSS_TENANT_AZURE_INTEGRATION.md

Updated CLAUDE.md to remove strategy doc references.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Reduces CLAUDE.md from 475 to 61 lines per governance standards:
- Top 5 NEVER/ALWAYS rules only
- Removed all C# code examples (file:line pointers instead)
- Removed JSON configuration examples (pointer to README)
- Removed plugin registration patterns
- Removed error handling examples
- Points to docs/reference/ for detailed patterns

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings January 14, 2026 14:46
@gemini-code-assist
Copy link

Summary of Changes

Hello @joshsmithxrm, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a significant documentation cleanup and a routine solution synchronization. The primary goal was to streamline the main CLAUDE.md document by making it more concise and relocating detailed strategy guides. Concurrently, the latest changes from the development environment, including a new custom field and updated version numbers, have been integrated into the solution's source.

Highlights

  • Documentation Refactoring: The CLAUDE.md file has been significantly refactored and trimmed to meet governance rules, reducing its content from 476 lines to 61 lines. It now serves as a high-level overview, pointing to other documentation for details.
  • Strategy Documentation Relocation: Several detailed strategy documents, including those covering ALM, branching, environment, pipeline, and cross-tenant Azure integration, have been removed from the docs/strategy/ directory, aligning with the goal of moving this documentation to a staging area.
  • Solution Synchronization: The PPDSDemo solution has been synchronized from the Dev environment, incorporating a new ppds_DemoField attribute and updating the solution's version metadata across various XML and text files.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR reduces CLAUDE.md from 476 lines to 61 lines to meet governance requirements, deletes strategy documentation files, and syncs solution files from the Dev environment including a new demo field.

Changes:

  • Trimmed CLAUDE.md to essential reference information (<100 lines)
  • Deleted 5 strategy documentation files (ALM_OVERVIEW.md, BRANCHING_STRATEGY.md, ENVIRONMENT_STRATEGY.md, PIPELINE_STRATEGY.md, CROSS_TENANT_AZURE_INTEGRATION.md)
  • Synced solution version to 1.0.20260113.59 and added ppds_DemoField to entity schema

Reviewed changes

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

Show a summary per file
File Description
CLAUDE.md Condensed from 476 to 61 lines, focusing on NEVER/ALWAYS rules and quick reference
docs/strategy/*.md Deleted 5 strategy documentation files
solutions/PPDSDemo/version.txt Updated version number
solutions/PPDSDemo/src/Other/Solution.xml Updated version and organization version
solutions/PPDSDemo/src/Other/Customizations.xml Updated organization version
solutions/PPDSDemo/src/Entities/ppds_DemoRecord/Entity.xml Added new ppds_DemoField attribute
Comments suppressed due to low confidence (5)

docs/strategy/PIPELINE_STRATEGY.md:1

  • This file is being deleted, but docs/README.md still references 'strategy/PIPELINE_STRATEGY.md' on line 18. This will create a broken link. The docs/README.md file should be updated to remove or update the reference to this deleted strategy documentation.
    docs/strategy/ENVIRONMENT_STRATEGY.md:1
  • This file is being deleted, but docs/README.md still references 'strategy/ENVIRONMENT_STRATEGY.md' on line 16. This will create a broken link. The docs/README.md file should be updated to remove or update the reference to this deleted strategy documentation.
    docs/strategy/BRANCHING_STRATEGY.md:1
  • This file is being deleted, but multiple documentation files reference it including docs/README.md (line 17), docs/guides/BRANCH_PROTECTION_GUIDE.md, docs/guides/GETTING_STARTED_GUIDE.md, docs/guides/HOTFIX_GUIDE.md, and docs/guides/ROLLBACK_GUIDE.md. All these references will become broken links and should be updated or removed.
    docs/strategy/ALM_OVERVIEW.md:1
  • This file is being deleted, but multiple documentation files reference it including docs/README.md (line 15), docs/guides/CLAUDE_MD_GUIDE.md, docs/guides/GETTING_STARTED_GUIDE.md, and docs/reference/PLUGIN_COMPONENTS_REFERENCE.md. All these references will become broken links and should be updated or removed.
    docs/strategy/CROSS_TENANT_AZURE_INTEGRATION.md:1
  • This strategy document is being deleted. While it appears less frequently referenced than other strategy docs, verify that no documentation files reference this file before deletion to avoid broken links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request effectively cleans up the CLAUDE.md documentation to meet governance requirements by trimming its content and moving detailed strategy documents. It also includes a solution sync from the development environment, adding a new field. My review includes a couple of suggestions: one to fix a broken documentation link in the updated CLAUDE.md and another to improve the definition of the newly added Dataverse entity field for better usability and adherence to best practices.

@joshsmithxrm joshsmithxrm changed the base branch from main to develop January 14, 2026 14:50
dependabot bot added 4 commits January 14, 2026 09:02
---
updated-dependencies:
- dependency-name: System.Text.Json
  dependency-version: 10.0.1
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
---
updated-dependencies:
- dependency-name: System.CommandLine
  dependency-version: 2.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps PPDS.Dataverse from 1.0.0-beta.3 to 1.0.0-beta.4
Bumps PPDS.Migration from 1.0.0-beta.3 to 1.0.0-beta.5

---
updated-dependencies:
- dependency-name: PPDS.Dataverse
  dependency-version: 1.0.0-beta.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: PPDS.Migration
  dependency-version: 1.0.0-beta.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
---
updated-dependencies:
- dependency-name: Microsoft.Identity.Web
  dependency-version: 4.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Breaking changes from beta to stable 2.0.1:
- AddOption/AddCommand extension methods removed - use collection initializer
- SetHandler removed - use SetAction with ParseResult
- Option constructor description parameter removed - use Description property
- IsRequired removed - use Required property
- InvokeAsync extension removed - use Parse().InvokeAsync()

Updated 16 files:
- Program.cs: collection initializer + SetAction + Parse().InvokeAsync()
- GlobalOptions.cs: Option constructor + Description/Required properties
- All 14 command files: collection initializer + SetAction pattern

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@joshsmithxrm joshsmithxrm merged commit 1389466 into develop Jan 15, 2026
7 checks passed
@joshsmithxrm joshsmithxrm deleted the docs/cleanup-staging branch January 15, 2026 18:33
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

Comments