Writing Guidelines (wip)

Cloning and Pushing Repo

The Blowfish theme that our website uses is added as a submodule. To run the Hugo server locally it is important that this is also pulled when the repo is cloned. The --recurse-submodules is needed when the repo is cloned.

git clone --recurse-submodules https://github.com/TechHutTV/techhut.tv.git

Pushing and committing changes can be done with the following.

git add -A
git commit -m "what I did"
git push

Images and Video

Make sure images have a descriptive file name with the number prefix being the order they appear in the article. All images must be .jpg, .jpeg, or .png with a strong preference of .jpg.

├── cover.jpg
├── images
│   ├── 1_zen-browser.png
│   ├── 2_zed-code-editor.png
│   ├── 3_tabby-terminal.png
│   ├── 4_cider-apple-music.png
│   └── 5_betterbird-email.jpg
└── index.md

Locally hosted videos can be added just like images in .mp4 or .webm format. File sizes must be under 50mb. See example below for HTML tagging of video.

{{< video src="images/cloning_panels_cc.webm" controls="yes" >}}

Youtube videos use the default hugo shortcodes.

{{< youtube y_8wcMBJrVo >}}

Structure and URL

Folder name should match what we want the url to be ie. linus-rust-drama-cosmic-alpha. Also, going forward we will exclude the url template tag so that news article fall under a date scheme in the url bar.

Editing Generated Article PRs

Command Line

# 1. Clone the repo (first time only)
git clone https://github.com/TechHutTV/techhut.tv.git
cd techhut.tv

# 2. Fetch and checkout the PR branch
git fetch origin
git checkout article/your-article-slug

# 3. Make your edits
# Edit content/YYYY/MM/your-article-slug/index.md
# Add/remove images in the images/ folder

# 4. Commit and push changes
git add .
git commit -m "Editorial fixes"
git push origin article/your-article-slug

GitHub CLI

# Checkout PR directly by number
gh pr checkout 123

# Make edits, then push
git add .
git commit -m "Editorial fixes"
git push

Editorial Checklist

• Fix AI-sounding phrases
• Verify technical accuracy
• Check frontmatter (title, tags, date)
• Add/remove/reorder screenshots
• Add image captions: ![alt text](images/filename.jpg)
• Insert screenshots into article body where relevant
• Delete unused/bad screenshots
• Set draft: false when ready to publish