Skip to content

docs(readme): move details into docs#40

Merged
tkkhq merged 2 commits into
mainfrom
docs/condense-readme
Jul 8, 2026
Merged

docs(readme): move details into docs#40
tkkhq merged 2 commits into
mainfrom
docs/condense-readme

Conversation

@tkkhq

@tkkhq tkkhq commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Condenses README to quickstart, contributing, and license; moves installation, authentication, and project configuration details into docs/.

Copilot AI review requested due to automatic review settings July 8, 2026 16:26
@tkkhq tkkhq requested a review from a team as a code owner July 8, 2026 16:26

Copilot AI left a comment

Copy link
Copy Markdown

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 streamlines the top-level README.md down to a quickstart, contributing, and license overview, relocating the more detailed installation, authentication, and project-configuration material into dedicated files under docs/. It also converts bare-filename mentions (e.g., CONTRIBUTING.md, LICENSE) into Markdown links. This improves README readability while keeping the detailed reference documentation discoverable via links.

Changes:

  • Removed the npm postinstall, Authentication, and Project configuration sections from README.md, replacing them with a "More detail lives in docs/" link list.
  • Added three new docs (installation.md, authentication.md, project-configuration.md) containing the relocated content, lightly reformatted into bullet lists.
  • Converted plain filename references in the README into proper Markdown links.

Reviewed changes

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

File Description
README.md Condenses content, links out to new docs, and converts filename mentions into Markdown links.
docs/installation.md New doc holding relocated installation and npm-wrapper details.
docs/authentication.md New doc holding relocated signup/login/logout and environment-targeting guidance.
docs/project-configuration.md New doc holding relocated volcano-config.yaml manifest and reconciliation semantics.

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

@swkeever swkeever left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Clean, faithful move overall — the split reads well and the quickstart is more correct now that it uses the installed volcano binary. One content-parity note left inline; not a blocker.

Comment thread docs/authentication.md
@tkkhq tkkhq merged commit fac25d1 into main Jul 8, 2026
8 checks passed
@tkkhq tkkhq deleted the docs/condense-readme branch July 8, 2026 18:41
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.

3 participants