atuinsh / atuinsh/docs

Request: Include a link to this repo at the bottom of the docs page

Open
#81 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
10
Forks
62
PR merge metrics
No merged PRs in 30d

Description

I think that we could get more people to contribute doc improvements if at the bottom of the official docs page (e.g. pages like https://docs.atuin.sh/configuration/config/#sync_address) there was a blurb similar to "Contribute to these docs at https://github.com/atuinsh/docs/blob/main/src/content/docs/configuration/config.mdx")

Also it was a little harder finding these docs because the main atuin repo (https://github.com/atuinsh/atuin/) _does_ have a `docs/` folder, but it only includes non-english docs and doesn't link here.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the official docs page linked in the issue and the example source file at src/content/docs/configuration/config.mdx. Find the shared page layout or footer used by these pages, add the repository contribution link there, and verify that it appears at the bottom of the rendered configuration page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.