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

Use subheaders consistently #1

Open
eliza411 opened this issue Apr 29, 2020 · 0 comments
Open

Use subheaders consistently #1

eliza411 opened this issue Apr 29, 2020 · 0 comments

Comments

@eliza411
Copy link

eliza411 commented Apr 29, 2020

Step 0 uses subheaders like

## Do the thing
### Create a file
### Slot in the code 
### Execute it 

Step 1 starts using steps

## Step 1: Authenticate ... 
## Step 2: Build  ...
#### Create app.py

Starting in Step 3, you no longer use a header for the different actions, and users would likely benefit from them to make it easier to find their place again and to allow direct linking to a step when someone needs help.

I think it makes sense to follow the H2 and H3 pattern from Step 0 and make liberal use of H3.

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

No branches or pull requests

1 participant