Skip to content

docs: Add Claude Code configuration persistence guides#3138

Open
akurinnoy wants to merge 3 commits into
mainfrom
docs/persist-claude-code-config
Open

docs: Add Claude Code configuration persistence guides#3138
akurinnoy wants to merge 3 commits into
mainfrom
docs/persist-claude-code-config

Conversation

@akurinnoy

Copy link
Copy Markdown
Contributor

What does this pull request change?

Adds a new "AI coding tools in workspaces" section to the User Guide with documentation on persisting Claude Code configuration across workspaces.

New pages:

  1. AI coding tools in workspaces - top-level section, extensible for other tools later
  2. Persisting Claude Code configuration - overview of config file locations (~/.claude/, ~/.claude.json), comparison of available approaches, file reference table
  3. Sharing configuration with a dedicated PVC - step-by-step guide with two options: direct mount (Option A) and full /tmp copy (Option B)
  4. Sharing configuration with GitOps - concept page describing the Git-based approach using DWO's project-clone init container
  5. Troubleshooting Claude Code configuration persistence - 7 known issues with symptoms, causes, and solutions

What issues does this pull request fix or reference?

resolves eclipse-che/che#23846

Specify the version of the product this pull request applies to

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown

🎊 Navigate the preview: https://6a4cd14fa5b682009af94ae4--eclipse-che-docs-pr.netlify.app 🎊

Add documentation for persisting and sharing Claude Code configuration
across Eclipse Che workspaces under a new "AI coding tools in workspaces"
section in the User Guide.

New pages:
- Overview of Claude Code configuration files and available approaches
- Dedicated PVC with automount (Option A: direct mount, Option B: /tmp copy)
- GitOps approach using a central Git repository
- Troubleshooting known issues with configuration persistence

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
@akurinnoy akurinnoy force-pushed the docs/persist-claude-code-config branch from 6ffdabe to 97c6dea Compare June 30, 2026 13:53
Comment thread modules/end-user-guide/pages/persisting-claude-code-configuration.adoc Outdated
@akurinnoy akurinnoy marked this pull request as draft July 1, 2026 12:19
Comment thread modules/end-user-guide/pages/persisting-claude-code-configuration.adoc Outdated
Comment thread modules/end-user-guide/pages/persisting-claude-code-configuration.adoc Outdated
Comment thread modules/end-user-guide/pages/persisting-claude-code-configuration.adoc Outdated
Comment thread modules/end-user-guide/pages/persisting-claude-code-configuration.adoc Outdated
Comment thread modules/end-user-guide/pages/sharing-claude-code-configuration-with-gitops.adoc Outdated
Comment thread modules/end-user-guide/pages/sharing-claude-code-configuration-with-gitops.adoc Outdated
- Rename all pages to imperative titles (CQA P10)
- Split PVC page into two separate procedures: direct mount and tmp copy (CQA P12)
- Change overview content type from ASSEMBLY to CONCEPT (CQA P3/P5)
- Rewrite abstracts to lead with user goal (CQA P11/JTBD)
- Merge adjacent admonitions (CQA Q10)
- Use {prod-home} consistently, replace bare ~/ paths (CQA Q20)
- Add full GitOps procedure with devfile snippets (JTBD)
- Split multi-command init pod step into separate steps (CQA Q14)
- Replace tail -f /dev/null with restartPolicy: Never in init pod
- Move persistUserHome compatibility note to overview (CQA Q5)
- Move non-troubleshooting section out of troubleshooting page
- Rewrite troubleshooting intro to user-centric language (CQA Q4/Q5)
- Add "how it works" flow summaries to both PVC procedure pages
- Add page-aliases for old filenames to preserve redirects

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
Comment thread modules/end-user-guide/pages/persist-claude-code-configuration.adoc
Comment thread modules/end-user-guide/pages/persist-claude-code-configuration.adoc Outdated
Comment thread modules/end-user-guide/pages/persist-claude-code-configuration.adoc Outdated
Comment thread modules/end-user-guide/pages/persist-claude-code-configuration.adoc Outdated
Comment thread modules/end-user-guide/pages/persist-claude-code-configuration.adoc Outdated
- Add DWO automount docs link to additional resources
- Fix asterisk rendering in pattern list
- Move PVC shared options (filtering, concurrent workspaces,
  persistUserHome compatibility, limitations) from overview
  to individual PVC procedure pages
- Add include/exclude annotations as multi-attach workaround
  in troubleshooting
- Add prerequisite about stopping workspaces before PVC creation
  on direct mount page

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
@akurinnoy akurinnoy marked this pull request as ready for review July 7, 2026 10:05
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.

As a developer I want Claude code configs (Skills, settings, and MCPs) persisted across my workspaces.

4 participants