Contribute an example book from a course outside computer science

Open Beginner friendly
#10 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
66/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
nodejs
Domain
content

Research direction

Start with the existing examples under books/, the computer-architecture course and the all-blocks demo, to see the shape of a book.json. Generate a book from a public-domain or openly licensed lesson and run npm run check until it passes. Done means a books/<name>/book.json that passes the check, with a PR note giving the source, licence, and the AI and model used.

Written by the indexing model from the issue text.

Description

enhancement good first issue help wanted
What problem would this solve?

The bundled examples are a computer-architecture course and the all-blocks demo. We'd love examples from biology, chemistry, maths, history or any other subject, to show what PopBook can do and to find the places where it falls short.

What would you like to happen?

Make a book from a public-domain or openly licensed lesson (or your own notes), check it with npm run check, and open a PR adding books/<name>/book.json. Do not include copyrighted PDFs or pages: only the generated book.json and a note in the PR about the source, the licence and which AI and model you used. If something looked wrong, please also open an issue about it.

Alternatives you've considered

No response

Contribution
  • I'd like to work on this myself
Dominant language
JavaScript
Stars
8
Forks
1
Avg merge
17m
Merged PRs (30d)
1

Getting set up

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 AlphaaCode/Popbook

All issues in AlphaaCode/Popbook

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.