Suggestion for Per Chapter Readme

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Locate the per-chapter README files and compare their current content order with the two example images in the issue. Done means the affected READMEs follow a clearer, consistent flow and the rendered content matches the intended arrangement.

Written by the indexing model from the issue text.

Description

Currently the content in per chapter Readme is not in a flow.

Example:

Image

It would be nice to make it in a better flow like:

Image

I would be happy to create a PR for it. Thanks.

gitlab id: dardama
Dominant language
Python
Stars
63
Forks
70
Avg merge
8d 18h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

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 Simulation-Software-Engineering/Lecture-Material

All issues in Simulation-Software-Engineering/Lecture-Material

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.