keybase / keybase/keybase-issues

Clarify what creating a gist named keybase.md means

Open
#1,538 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
No language data
Stars
899
Forks
40
PR merge metrics
No merged PRs in 30d

Description

Since a gist can potentially contain several files, it is, at least for people who don't regularly make gists, not immediately clear that `keybase.md` should be entered as the name of the file, rather than the gist description. I guessed correctly while creating my github proof, but did have to guess.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the GitHub proof instructions that tell users to create a gist named keybase.md. Clarify that keybase.md is the filename within the gist, not the gist description, and confirm the revised wording is understandable during gist creation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.