docs: restructure the README around the published package - #2
Merged
Conversation
The README had grown into working notes from the migration: the parity evidence, the toolchain archaeology, and the Central setup all sat above the things a consumer needs first. It read as a record of how the package came to exist rather than as documentation of the package. README.md now covers what the package is, how to depend on it, what is in it, and how to update the contract. The depth moves to docs/, kept because it is the only place the reasoning is written down: - docs/generation.md — the sync, both generator toolchains and their pins, the transitive grpc-swift-2 pin that is the reason toolchain.env exists, and what CI checks. - docs/releasing.md — the publish workflow, the signing secrets, and the one-time keyserver and namespace setup. - docs/migration.md — what the vendored copies were, the parity numbers from the cutover, and why that gate is gone. No content is dropped.
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
1 participant
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.
The README had grown into working notes from the migration. The parity evidence, the toolchain archaeology, and the Maven Central setup all sat above the things someone depending on this package needs first, so it read as a record of how the package came to exist rather than as documentation of the package.
README.mdis now what it should be: what the package is, the Kotlin and Swift coordinates, how to depend on it, what is in it, the layout, and how to update the contract.The depth moves into
docs/rather than being deleted — it is the only place any of this reasoning is written down:docs/generation.md— the sync and itsjava_packagerewrite, both generator toolchains with their pinned versions, the transitive grpc-swift-2 pin that is the reasontoolchain.envexists, and what CI checks on each side.docs/releasing.md— the publish workflow, the five signing secrets, coordinates vs namespace, and the one-time keyserver and Central namespace steps.docs/migration.md— what the vendored copies were, the parity numbers from the cutover, and why that gate retired with them.No content is dropped.