github / github/markup

Include code files

Open
#2,084 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
6k
Forks
3.4k
PR merge metrics
No merged PRs in 30d

Description

#1524

It would be great to have a way to include code files into README.rst. By separating the code to another file, we can do static type checking etc. on our examples to ensure they are always running correctly.

(I don't what the point of adding a stale bot is, if nobody triages the issues here...)

Contributor guide

Open the contributing guide

Research direction

Start by reading the referenced issue #1524 and the README.rst examples to determine the intended code-file inclusion behavior. Trace how README.rst is currently processed, then define and test a complete inclusion path whose behavior is clear for separated, statically checked examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.