Repository navigation
docs: rewrite the root README around getting started and the repo's three parts - #593
Merged
Merged
Conversation
…hree parts Lead with what Taskless is and the docs.taskless.io quick start, then describe what the repo holds: the CLI, the Vale platform packages, and the canonical Taskless skill. Replace the stale manual release steps with the automated Changesets + OIDC flow, and drop init from the human path.
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.
The root README didn't say what Taskless is or what this repository holds. It now reads in three parts:
npx @taskless/cli, get onboarded, create a rule, then check your code. It no longer tells people to runinit, becauseinitis for agents and scripts, not humans.@taskless/cli@taskless/vale-*platform packages: the Vale binaries wrapped in npm packages and published over OIDCIt also fixes outdated content:
pnpm release:productionwith a 2FA prompt and hand tagging. It now describes the automated flow: a Changesets PR, thenrelease-cli.ymlpublishes over OIDC and tags the release..txtfiles with{{CLI_VERSION}}placeholders. They're.mdfiles now, and none use placeholders.taskless agent, which prints the current list.The Marketing Assets session reviewed the copy for voice and tone.
There's no changeset, since the root README isn't part of any published package.