Skip to content

Commit d94f980

Browse files
author
yoshibase
committed
docs: explain when edit/GitHub buttons are missing
Clarify that question-style queries (/LANG/QUESTION) aggregate Stack Overflow answers and do not show in-browser edit controls. Fixes #149
1 parent 031a5d3 commit d94f980

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -855,6 +855,24 @@ committed in the forked repository, a pull request to the upstream repository ow
855855

856856
![cheat.sh cheat sheets repositories](http://cheat.sh/files/edit-cheat-sheet.png)
857857

858+
### When there is no edit or GitHub button
859+
860+
The in-browser **[edit]** link and the per-sheet GitHub button at the bottom of the page
861+
appear only when cheat.sh shows a **single** answer from the
862+
[cheat.sheets](https://github.com/chubin/cheat.sheets) repository
863+
(for example `curl cheat.sh/python` or `curl cheat.sh/go`).
864+
865+
If you opened a page using a **question query** (`/LANGUAGE/QUESTION`,
866+
for example `/python/read+json`), cheat.sh aggregates answers from Stack Overflow
867+
and other sources. These pages are **not editable on cheat.sh** and do not show
868+
the upstream-repository button.
869+
870+
To improve question-style answers:
871+
872+
* edit or answer the underlying thread on [Stack Overflow](https://stackoverflow.com), or
873+
* add or update a cheat sheet in [chubin/cheat.sheets](https://github.com/chubin/cheat.sheets)
874+
so it can be served as a direct topic query.
875+
858876
### How to add a cheat sheet
859877

860878
If you want to add a cheat sheet, you have one of the following

0 commit comments

Comments
 (0)