ruby / ruby/lrama

Create a manual like the manual that Bison offers

Open
#479 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
318
Forks
33
Avg merge
1d 18h
Merged PRs (30d)
8

Description

Like this: https://www.gnu.org/software/bison/manual/html_node/index.html#SEC_Contents

I think the markdown format is sufficient as a first step.
Hopefully it will eventually generate something that can be viewed as a web page.

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.

Research direction

The issue names no files, tests, or documentation entry points. Start by reviewing the linked GNU Bison manual and deciding which sections belong in an initial Markdown manual; define the required structure and how a web-page view will be produced before considering the work complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.