Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve link to developer docs #3751

Closed
wants to merge 1 commit into from

Conversation

cbeams
Copy link
Member

@cbeams cbeams commented Dec 5, 2019

The previous link format works fine while in the GitHub web interface,
but is not useful when trying to navigate from the filesystem. This
format works well in both contexts.

This minor issue was discovered in the course of documentation updates
for PR #3718.

The previous link format works fine while in the GitHub web interface,
but is not useful when trying to navigate from the filesystem. This
format works well in both contexts.

This minor issue was discovered in the course of documentation updates
for PR bisq-network#3718.
@cbeams cbeams requested a review from ripcurlx as a code owner December 5, 2019 20:48
@cbeams
Copy link
Member Author

cbeams commented Dec 5, 2019

Closing as dropped. I remembered just now why I originally used the docs#readme link format. When clicked (via the web interface), it takes you to https://github.com/bisq-network/bisq/tree/master/docs#readme instead of https://github.com/bisq-network/bisq/blob/master/docs/README.md, and there's an important difference between the two. The former scrolls the user to the README text, but the user can also easily scroll up and see the list of all files in the docs/ directory. This is good for discoverability and context. The latter link format takes the user directly to the README.md file, and they'd have to navigate up to the docs/ directory to see the other files.

@cbeams cbeams closed this Dec 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant