Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

README.md is out of sync with docs/

See original GitHub issue

I have searched the issues of this repo and believe that this is not a duplicate.

Issue

Subj. It especially easy to see comparing README.md and docs/docs/cli.md “Commands” sections. For example in Readme.md:

Whole introduction and section Global options is missing
--src option is missing for new command
--git, --path, --extras are missing for add command etc.

It’s confusing and hard to maintain. Solution I see is to just leave minimal text and link to full documentation at poetry.eustace.io in Readme.md. Many projects acts this way, for example: django, flask, aiohttp.

What do you think about it?

Issue Analytics

State:
Created 5 years ago
Reactions:1
Comments:9 (1 by maintainers)

Top GitHub Comments

2reactions

darcydevcommented, Jan 7, 2019

I have made a PR that acts as an interim solution (until a link is provided to the full documentation at poetry.eustace.io in Readme.md).

The PR brings README.md inline with docs/docs/cli.md “Commands” sections

It’s my first contribution, thank you! 😃

1reaction

thernstigcommented, Jan 8, 2019

@darcyprice Nice! I think it could require some work to refine, but it is a great start. I think the actual review is better left to a maintainer.

Top Results From Across the Web

Syncing Docs via CLI / GitHub - ReadMe Documentation

Update your docs automatically with rdme, ReadMe's official CLI and GitHub Action! ... In order to sync Markdown files to your Guides, your...

How can I sync documentation with Github Pages?

I am going to post a solution that I setup that takes advantage of the fact that GitHub Pages uses Jekyll already using...

Troubleshooting - GitBook Documentation

I have a GitHub sync error ... Your repository has a README.md file at its root (or at the root folder specified in...

Chromium Docs - Google Git

Checking Out and Building; Design Docs; Integrated Development Environment ... e.g. https://chromium-review.googlesource.com/c/3362532/2/docs/README.md ...

Syncing Docs From Code Repositories to Notion - Swiftlane

... most programmers like using [README.md](http://readme.md) files and other documents within their code repository to document their work.