README instructions for writing blog entries do not work as-is

Open Beginner friendly
#94 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
bun
Domain
documentation

Research direction

Update the README instructions for writing blog entries. Verify the documented setup by checking the make dev and make install workflow, then state that Bun is required and that make install must run before make dev; done means a new contributor can follow the instructions without encountering the reported errors.

Written by the indexing model from the issue text.

Description

The README currently says:

You can pull the repo, run make dev, and edit the page via Keystatic with the nice UI

I did so, and noticed that this had an implicit dependency on Bun. This dependency should be called out.

After installing Bun, I got a different failure due to the astro not being installed:

❯ make dev        
bun run dev
$ astro dev
/bin/bash: astro: command not found
error: script "dev" exited with code 127
make: *** [dev] Error 127

This is because, the user needs to do a make install before make dev.

I did end up writing it in Markdown, since I'm familiar with that.

Dominant language
Astro
Stars
32
Forks
12
Avg merge
9h 37m
Merged PRs (30d)
9

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/python-insider-blog

All issues in python/python-insider-blog

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.