Skip to content

Commit 7def602

Browse files
agladsteinmergify[bot]
authored andcommitted
added github button to docs and updated docs text
1 parent d5d3fb6 commit 7def602

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

docs/_config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ sphinx:
4646
html_theme_options:
4747
pygments_dark_style: monokai
4848
navigation_with_keys: false
49+
repository_url: https://github.com/tskit-dev/tskit
50+
repository_branch: main
51+
path_to_docs: docs
52+
use_repository_button: true
53+
use_edit_page_button: true
54+
use_issues_button: true
4955
pygments_style: monokai
5056
myst_enable_extensions:
5157
- colon_fence

docs/development.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -340,16 +340,14 @@ on GitHub, and help us fix any, or add issues for anything that's wrong or missi
340340
If you see a typo or some other small problem that you'd like to fix,
341341
this is most easily done through the GitHub UI.
342342

343-
If the typo is in a large section of text (like this page), go to the
344-
top of the page and click on the "Edit on GitHub" link at the top
345-
right. This will bring you to the page on GitHub for the RST
346-
source file in question. Then, click on the pencil icon on the
347-
right hand side. This will open a web editor allowing you to
343+
Mouse over the GitHub icon at the top right of the page and
344+
click on the "Suggest edit" button. This will bring you to a web
345+
editor on GitHub for the source file in question, allowing you to
348346
quickly fix the typo and submit a pull request with the changes.
349-
Fix the typo, add a commit message like "Fixed typo" and click
350-
on the green "Propose file change" button. Then follow the dialogues
351-
until you've created a new pull request with your changes,
352-
so that we can incorporate them.
347+
Fix the typo, click the "Commit changes", add a commit message like
348+
"Fixed typo" and click on the green "Propose file change" button.
349+
Then follow the dialogues until you've created a new pull request
350+
with your changes, so that we can incorporate them.
353351

354352
If the change you'd like to make is in the API documentation
355353
for a particular function, then you'll need to find where this

0 commit comments

Comments
 (0)