Skip to content

Polish docs wording and reduce visual text density#40

Merged
lipkau merged 7 commits into
masterfrom
docs-review
May 19, 2026
Merged

Polish docs wording and reduce visual text density#40
lipkau merged 7 commits into
masterfrom
docs-review

Conversation

@lipkau
Copy link
Copy Markdown
Member

@lipkau lipkau commented May 17, 2026

Summary

  • refactor Contributing docs into shorter, task-oriented pages with clearer contributor flow
  • replace placeholder content in writing guides with concrete function and test guidance
  • modernize and tighten wording across Contributing and Gallery pages while keeping a warm, welcoming tone
  • add subtle emoji signposts and GitHub-native markdown alerts ([!TIP], [!NOTE], [!IMPORTANT], [!CAUTION]) to improve scanability
  • add a docs hygiene workflow to catch stale placeholder language, outdated develop-branch guidance, and broken local docs links

Test plan

  • bundle exec jekyll build --baseurl ""
  • Spot-check /docs/Contributing/ flow and readability
  • Spot-check /docs/Gallery/ template and contribution instructions

@lipkau lipkau requested a review from a team as a code owner May 17, 2026 23:32
@lipkau lipkau force-pushed the docs-review branch 2 times, most recently from a43ca4a to ee63747 Compare May 18, 2026 14:20
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
lipkau and others added 6 commits May 19, 2026 08:45
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@lipkau lipkau merged commit 92c3a5e into master May 19, 2026
2 checks passed
@lipkau lipkau deleted the docs-review branch May 19, 2026 20:38
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

Successfully merging this pull request may close these issues.

1 participant