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.

Sign up for GitHub

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

Jump to bottom

Chore: Edit down README.md and update to latest Tech Stack #93

Open
3 of 4 tasks
nelsonic opened this issue Feb 19, 2023 · 0 comments
Open
3 of 4 tasks

Chore: Edit down README.md and update to latest Tech Stack #93

nelsonic opened this issue Feb 19, 2023 · 0 comments
Assignees
@nelsonic
Labels
chore a tedious but necessary task often paying technical debt discuss Share your constructive thoughts on how to make progress with this issue documentation Improvements or additions to documentation help wanted If you can help make progress with this issue, please comment! priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished T2h Time Estimate 2 Hours tech-debt A feature/requirement implemented in a sub-optimal way & must be re-written

Comments

@nelsonic
Copy link
Member

nelsonic commented Feb 19, 2023 •
edited
Loading

At present the initial README.md of this repo is a bit "ramble-y" ... 🙃
I think we could/should either trim it down by at least half ✂️
or even re-write it completely to joint point people to the book: https://dwyl.github.io/book 💭

Todo

  • Decide if there is anything in the current README.md that is worth keeping.
  • Re-work the README.md so that it gives just enough info about what we're doing.
  • Then link to the book.
  • Question: should we host the book on a subdomain e.g: book.dwyl.com for SEO? 💭
@nelsonic nelsonic added priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished chore a tedious but necessary task often paying technical debt discuss Share your constructive thoughts on how to make progress with this issue help wanted If you can help make progress with this issue, please comment! tech-debt A feature/requirement implemented in a sub-optimal way & must be re-written T2h Time Estimate 2 Hours documentation Improvements or additions to documentation labels Feb 19, 2023
nelsonic added a commit that referenced this issue Aug 21, 2023
@nelsonic
add instructions for how to run the book on localhost #93
05b3136
@nelsonic nelsonic self-assigned this Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nelsonic nelsonic

Labels
chore a tedious but necessary task often paying technical debt discuss Share your constructive thoughts on how to make progress with this issue documentation Improvements or additions to documentation help wanted If you can help make progress with this issue, please comment! priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished T2h Time Estimate 2 Hours tech-debt A feature/requirement implemented in a sub-optimal way & must be re-written
Projects
dwyl app kanban
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nelsonic