Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify main README #884

Open
4 tasks
Nana-EC opened this issue Dec 12, 2024 · 0 comments
Open
4 tasks

Simplify main README #884

Nana-EC opened this issue Dec 12, 2024 · 0 comments

Comments

@Nana-EC
Copy link
Contributor

Nana-EC commented Dec 12, 2024

Problem

The currnet README is long and detailed, with a mixture of nom and docker commands and focus.
This can be confusing and unclear

Solution

Let's simplify the READE with a clear focus on the npm approach first and the docker approach as pone for power users

  • Move docker requirements setup into a separate README with a link in the main README
  • Streamline install and run steps to be npm only
  • Move docker install and run step into separate README and link in main README
  • Add a section for common issues that link to a separate README with common issues that users may hit on setup - usually due to not following instructions or because of left over artifacts from other docker sessions

The goal is for a simplified experience with extra details readily available

Alternatives

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Sprint Backlog
Development

No branches or pull requests

1 participant