Repository navigation
docs: centralize setup guides and breaking-change migration notes - #4
Draft
Winter-Soren wants to merge 1 commit into
Draft
Winter-Soren wants to merge 1 commit into
Winter-Soren wants to merge 1 commit into
Conversation
Preserve 41 application documents in the documentation repository, with a path migration index, a minimal setup guide, and credential acquisition instructions for optional integrations. Keep existing feature documentation. Document confirmed breaking changes separately from possible regressions, including configuration names, authentication, packaging, storage removal, and deployment behavior. Include rollout/rollback steps and validation limits. Validation: 98 local documentation links checked across both repositories; Authored-guide whitespace checks pass. Historical document claims and formatting are preserved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem and result
Setup and integration guidance was scattered across the application tree, while credential requirements and upgrade behavior were unclear. This PR preserves 41 moved documents, adds a path index, and provides current environment, validation, and migration guides. Historical claims and formatting stay marked as historical.
The companion application PR #7 uses
fix/audit-cleanup-breaking. Merge this documentation PR first using a merge commit so the parent repository's pinned commit remains reachable. If squash/rebase merging, update the application submodule pointer to the resulting commit before merging that PR.Breaking-change guidance
Migration guide distinguishes confirmed configuration/API/install/path changes from probable regressions, and includes rollout/rollback steps. It covers server-only storage keys, Mongo database preservation, run/chat/pharma authentication, optional chemistry, deployment behavior, and relocated automatic tool guidance.
Missing credentials for merged integrations are setup gaps; this work preserves their code and explains where to obtain access. No real credentials are included.
Validation and limits
This is a draft for contributor review. It does not merge main, create a release tag, or deploy production source.