every.to/guides/compound-engineering is outdated (broken links)

Open
#555 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Find the guide at https://every.to/guides/compound-engineering and inspect the command references and GitHub links. Update /workflows:plan to /ce:plan and correct the broken command link to point into src/commands. Done when the guide uses the current command name and the link resolves.

Written by the indexing model from the issue text.

Description

I was showing a friend how to use the tool, and ended up on the "full reference": https://every.to/guides/compound-engineering

Image

problems i noticed:

  1. /workflows:plan instead of /ce:plan
  2. broken links - https://github.com/EveryInc/compound-engineering-plugin/blob/main/commands/workflows/brainstorm.md <- missing src, should have .../main/src/commands
Dominant language
TypeScript
Stars
25.6k
Forks
2.1k
Avg merge
3h 57m
Merged PRs (30d)
170

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EveryInc/compound-engineering-plugin

All issues in EveryInc/compound-engineering-plugin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.