General questions about the "reallysimple" process...

Open
#4 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, node.js
Domain
documentation

Research direction

The issue points to feeder's README.md and docs/templates.md; start by reading those documents and running feeder with feeds you know. A contribution is not defined here, so use the questions and discussion to identify a concrete documentation change before estimating when it is done.

Written by the indexing model from the issue text.

Description

I've been working for quite some time, a couple of years at least, on a set of building blocks for feed writing and reading, in time for the twenty-year anniversary of RSS 2.0 in September. Over the last couple of weeks, I've released code for the first lowest-level blocks. I imagine this is a bit hard to grasp at first. I'm here to explain, to answer questions.

Eventually there will be a set of blocks that can be used to build all parts of a feed reading and writing system. What we're doing now is the lowest level of the stack.

  • A good place to start is the readme for the feeder app, which is the current top level of the reallysimple stack. Try giving it some feeds you know, maybe even your own, and see what it give you back.

  • Also the docs for feeder templates, another building block.

  • If you have questions, post a comment below.

Dominant language
JavaScript
Stars
104
Forks
3
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 scripting/reallysimple

All issues in scripting/reallysimple

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.