1jehuang / 1jehuang/jcode

Onboarding: More helpful documentation

Open
#939 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

autonomous: no documentation enhancement priority: high triage: needs-decision ux
Dominant language
Rust
Stars
19.9k
Forks
2.3k
Avg merge
2d 7h
Merged PRs (30d)
30

Description

This looks to be a very interesting harness and I want to know more about it. However, the documentation is not helpful to new users, as it fails to give a basic introduction to the product. It goes straight from installation to some technical explanation about performance, memory usage and time to first input etc. It doesn't explain anything to new users about how to actually use the product.

There are some genuinely innovative features like the memory system and the swarm features and the side panel for example. But there are no examples of how to actually USE those features. Like the side bar for example, you just "tell jcode to load something into the side bar". But there is no explanation how to do that, how to even open the side bar. The swarm features are kind of explained but all the time I was trying jcode I had no idea if it was using any of those features. The natural-language configuration references Fable-5 by default and is frankly incomprehensible to most people.

So don't take this the wrong way, I'm really optimistic about this project, but please try to reduce the friction and lower the learning curve for onboarding of new users. Replace the AI generated documentation about highly technical, niche implementation details and add write more beginner friendly, keypress-by-keypress, tutorial-like instructions. Like:

  • Your first prompt
  • The memory system in action
  • How to use the side bar
  • Swarms in the same codebase - a practical example

These pages would be infinitely more helpful than the current documentation - imo.

Contributor guide

Open the contributing guide

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.

Research direction

No documentation files or tests are named; start by reviewing the current installation section and its performance, memory, and time-to-first-input material. Use the product to trace the first prompt, memory system, side bar, and swarm workflows, then replace the technical onboarding with keypress-by-keypress tutorials and practical examples.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.