Skip to content
New issue

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

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

Already on GitHub? # to your account

Documentation TODO: easy linking between docs and code #8

Open
thundergolfer opened this issue Jul 4, 2021 · 0 comments
Open

Documentation TODO: easy linking between docs and code #8

thundergolfer opened this issue Jul 4, 2021 · 0 comments

Comments

@thundergolfer
Copy link
Owner

At the moment if you're on https://thundergolfer.com/uni it's not simple to look at the code associated with each README (_index.md) file.

A user should be able to land on a page like https://thundergolfer.com/uni/docs/operating_systems/linux/strace_in_seventy_lines/ and quickly jump to https://github.com/thundergolfer/uni/tree/master/operating_systems/linux/strace_in_seventy_lines

Should I prepend a header to each readme.md file in update_doc.sh that contains a listing of the sibling files? Like how GIthub does it. Or should I just link to Github directly with 'See The Code'.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant