Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main
- toyibat
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- uses: peaceiris/actions-hugo@v3
with:
hugo-version: '0.147.0'
extended: true
- name: Install dependencies
run: npm ci
- name: Copy layout override
run: cp layouts/index.html node_modules/@thulite/doks-core/layouts/index.html; cp layouts/index.html node_modules/@thulite/core/layouts/index.html || true

- name: Build
run: hugo --minify --gc --baseURL "https://writetech-hub.github.io/wth-docs-lab/"
env:
HUGO_ENVIRONMENT: production
- name: Check public folder
run: ls -la public/ | head -20

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./public
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- id: deployment
uses: actions/deploy-pages@v4
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
public/
node_modules/
resources/_gen/
.hugo_build.lock
8 changes: 6 additions & 2 deletions config/_default/hugo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title = "WTH Docs Lab"
baseurl = "http://localhost/"
baseurl = "https://writetech-hub.github.io/wth-docs-lab/"
canonifyURLs = false
disableAliases = false
disableHugoGeneratorInject = true
Expand Down Expand Up @@ -47,7 +47,7 @@ copyRight = "Copyright (c) 2020-2024 Thulite"
priority = 0.5

[caches]
[caches.getjson]
[caches.getresource]
dir = ":cacheDir/:project"
maxAge = -1 # "30m"

Expand Down Expand Up @@ -84,3 +84,7 @@ copyRight = "Copyright (c) 2020-2024 Thulite"
hint = "photo"
quality = 85
resampleFilter = "Lanczos"

[security]
[security.exec]
allow = ['postcss', 'node']
12 changes: 6 additions & 6 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hugo
title = "WTH Docs Lab"
description = "Congrats on setting up a new Doks project!"
title = "WriteTech Hub Resource Library"
description = "A structured learning path for technical writers from beginner to advanced."
images = ["cover.png"]

# mainSections
Expand Down Expand Up @@ -41,13 +41,13 @@ mainSections = ["guides"]
alertDismissable = true # true (default) or false

# Bootstrap
bootstrapJavascript = false # false (default) or true
bootstrapJavascript = true # false (default) or true

# Nav
sectionNav = ["docs"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
sectionNav = ["docs", "guides"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
toTopButton = false # false (default) or true
breadcrumbTrail = false # false (default) or true
headlineHash = true # true (default) or false
headlineHash = false # true (default) or false
scrollSpy = true # true (default) or false

# Multilingual
Expand All @@ -59,7 +59,7 @@ mainSections = ["guides"]
docsVersion = "1.0"

# UX
headerBar = false # true (default) or false
headerBar = true # true (default) or false
backgroundDots = true # true (default) or false

# Homepage
Expand Down
14 changes: 7 additions & 7 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Welcome to WriteTech Hub Docs Lab"
description: ""
lead: "Congrats on setting up a new Doks project!"
title: "WriteTech Hub Resource Library"
description: "A structured learning path for technical writers — beginner to advanced."
lead: "A structured, practitioner-built resource library for technical writers."
date: 2023-09-07T16:33:54+02:00
lastmod: 2023-09-07T16:33:54+02:00
draft: false
seo:
title: "Welcome to WTH Docs Lab" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
robots: "" # custom robot tags (optional)
title: "WriteTech Hub Resource Library"
description: "A structured learning path for technical writers at beginner, intermediate, and advanced levels."
canonical: ""
robots: ""
---
71 changes: 60 additions & 11 deletions content/guides/_index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,64 @@
---
title: "Guides"
description: ""
summary: ""
date: 2023-09-07T16:12:03+02:00
lastmod: 2023-09-07T16:12:03+02:00
---
title: "Technical Writing Resources"
description: "A curated resource bank for technical writers at every level beginner, intermediate, and advanced."
summary: "Structured learning path with capstone deliverables for technical writers."
date: 2026-06-14T20:51:00+01:00
lastmod: 2026-06-14T20:51:00+01:00
type: guides
draft: false
weight: 999
weight: 100
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
robots: "" # custom robot tags (optional)
title: "Technical Writing Resources - WriteTech Hub"
description: "Curated learning resources for technical writers at beginner, intermediate, and advanced levels."
canonical: ""
robots: ""
---

This repository is a curated resource bank for technical writers at every level. Whether you are just getting started, actively practising, or working on complex documentation projects, there is a starting point here for you.

The resources are organised into three levels: **Beginner**, **Intermediate**, and **Advanced**. Each level follows the same structure: you learn a concept, study the relevant resources, practise applying it, and work toward a concrete deliverable you can add to your portfolio.

Start at the level that matches where you are now. If you are unsure, begin with [Beginner](beginner.md).

## Levels

- **Beginner**: Foundations
- **Intermediate**: Practice and Delivery
- **Advanced**: Systems and Scale

## How the levels work

Each level closes with a capstone deliverable. It is the practical proof that you have absorbed what the level covers and are ready to move forward. Build it, review it honestly, and use it as a portfolio piece.

The resources within each level are there to support the work, not replace it. Read enough to understand the concept, then practise.

## Community

WriteTech Hub is a community for technical writers at all levels. This repository is one of the ways we support writers with structured learning and practical growth.

Technical writing is easier when you're not doing it alone. You improve faster when you share your work, ask questions, and get feedback from people who understand the craft.

We encourage you to:

- Share your progress as you move through each level
- Ask questions whenever something is unclear
- Request feedback and reviews on your documentation
- Review and learn from other people's work
- Build in public instead of waiting until things feel perfect

You can engage with us by:

- Opening an Issue in this repository to ask questions or request feedback
- Submitting Pull Requests to improve resources or suggest additions
- Sharing your capstone projects for review
- Collaborating with other writers on documentation practice
- Joining our [Slack community](https://writetechhub.org) to connect, ask questions, and get faster feedback from other writers

Don't wait until you feel ready. Start early, share your work, and improve through feedback. That's how technical writers grow.

---

**Contact**: [info@writetechhub.org](mailto:info@writetechhub.org)
**Website**: [writetechhub.org](https://writetechhub.org)
**Community**: [WriteTech Hub](https://writetechhub.org)
Loading
Loading