-
Notifications
You must be signed in to change notification settings - Fork 1
Plan Awesome GitHub site phases #753
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
Changes from all commits
144c2b3
329a0a4
f59c630
56778d9
e95ccd4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| file_type: documentation | ||
| title: "Issue Execution Plan - Awesome GitHub Site" | ||
| description: "Ordered issue plan for the Awesome GitHub website, covering the phase 1 MVP and the phase 2 expansion." | ||
| version: "1.0.0" | ||
| created_date: "2026-06-03" | ||
| last_updated: "2026-06-03" | ||
| status: active | ||
| stability: stable | ||
| domain: website | ||
| owners: | ||
| - Ash Shaw | ||
| tags: | ||
| - planning | ||
| - issues | ||
| - website | ||
| - opsx | ||
| --- | ||
|
|
||
| # Issue Execution Plan | ||
|
|
||
| ## 3-Bullet Summary | ||
|
|
||
| - Value: gives the website a strict delivery sequence so the first release stays small and useful. | ||
| - Risks: phase 2 material leaking into phase 1, unclear page ownership, and copy drift away from the source briefs. | ||
| - Next step: lock the phase 1 issue chain, then hold phase 2 as the expansion path after the MVP is stable. | ||
|
|
||
| ## Delivery Order | ||
|
|
||
| ### Phase 1 | ||
|
|
||
| 1. Source audit and scope lock | ||
| 2. Phase 1 information architecture and page map | ||
| 3. Phase 1 copy normalisation from the briefing docs | ||
| 4. MVP site scaffold and page build | ||
| 5. Validation and launch readiness | ||
|
|
||
| ### Phase 2 | ||
|
|
||
| 1. Full information architecture and content model | ||
| 2. Layout and browsing system expansion | ||
| 3. Content migration and page population | ||
| 4. Search or discovery enhancements | ||
| 5. Visual polish, accessibility pass, and full launch validation | ||
|
|
||
| ## Suggested Issue Structure | ||
|
|
||
| ### Phase 1 | ||
|
|
||
| - Parent: `Awesome GitHub Site - Phase 1 MVP` | ||
| - Child 1: `Source audit and scope lock` | ||
| - Child 2: `Information architecture and page map` | ||
| - Child 3: `Copy normalisation and content model` | ||
| - Child 4: `MVP site scaffold and page build` | ||
| - Child 5: `Validation and launch readiness` | ||
|
|
||
| ### Phase 2 | ||
|
|
||
| - Parent: `Awesome GitHub Site - Phase 2 Full Website` | ||
| - Child 1: `Full information architecture and content model` | ||
| - Child 2: `Category browsing and layout system` | ||
| - Child 3: `Content population and resource structure` | ||
| - Child 4: `Discovery, search, and supporting guides` | ||
| - Child 5: `Accessibility, polish, and launch validation` | ||
|
|
||
| ## OpenSpec Notes | ||
|
|
||
| - Use the phase split above when preparing `/opsx:propose` inputs. | ||
| - Keep proposal files phase-specific so phase 1 can ship without waiting for phase 2 detail. | ||
| - Treat the normalised briefs in `briefs/` as the source of truth for the first planning pass. | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| - Phase 1 is bounded to 1-3 pages and can be launched independently. | ||
| - Phase 2 expands the MVP without replacing the phase 1 structure. | ||
| - The source briefs are aligned to repo documentation standards. | ||
| - The active-project tracker reflects the new workstream. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
| file_type: documentation | ||
| title: "Awesome GitHub Site" | ||
| description: "Active project plan for the Awesome GitHub website, split into a launchable phase 1 MVP and a fuller phase 2 site." | ||
| version: "1.0.0" | ||
| created_date: "2026-06-03" | ||
| last_updated: "2026-06-03" | ||
| status: active | ||
| stability: stable | ||
| domain: website | ||
| owners: | ||
| - Ash Shaw | ||
| tags: | ||
| - planning | ||
| - website | ||
| - github | ||
| - opsx | ||
| - open-spec | ||
| --- | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| # Awesome GitHub Site | ||
|
|
||
| ## 3-Bullet Summary | ||
|
|
||
| - Value: turns the reference material into a small, shippable GitHub site first, then expands it into the fuller catalogue-style experience. | ||
| - Risks: phase creep, copy that stays too talk-specific, and a phase 2 structure that gets pulled into phase 1 too early. | ||
| - Next step: run the phase 1 issue chain first, using the normalised briefs in `briefs/` as the source of truth. | ||
|
|
||
| ## Overview | ||
|
|
||
| `Awesome GitHub` is the working name for a GitHub-led website inspired by the structure and content discipline of `awesome-copilot`. | ||
|
|
||
| The delivery is intentionally split: | ||
|
|
||
| 1. Phase 1 ships a compact 1-3 page MVP. | ||
| 2. Phase 2 expands that MVP into the full resource-style site. | ||
|
|
||
| ## Project Inputs | ||
|
|
||
| - Reference site: `awesome-copilot` | ||
| - Source repository for reference structure: `github/awesome-copilot/website` | ||
| - Source briefs: | ||
| - `briefs/mini-site-plan.md` | ||
| - `briefs/page-copy-starter.md` | ||
|
|
||
| ## Project Outputs | ||
|
|
||
| - Phase 1 planning and issue sequence | ||
| - Phase 2 expansion planning and issue sequence | ||
| - Normalised source briefs aligned to repo conventions | ||
| - Execution tracker updates in `next-issues-execution-plan.md` | ||
|
|
||
| ## Phase Split | ||
|
|
||
| ### Phase 1 | ||
|
|
||
| Build the smallest useful version of the site: | ||
|
|
||
| - Home | ||
| - Why this exists | ||
| - References or Sources | ||
|
|
||
| ### Phase 2 | ||
|
|
||
| Expand the site into the full experience: | ||
|
|
||
| - resource catalogue pages | ||
| - category browsing | ||
| - richer navigation | ||
| - supporting guides and discovery flows | ||
|
|
||
| ## References | ||
|
|
||
| - [Phase 1 plan](phase-1/README.md) | ||
| - [Phase 2 plan](phase-2/README.md) | ||
| - [Issue execution plan](ISSUE_EXECUTION_PLAN.md) | ||
| - [Run log](RUN_LOG.md) | ||
| - [OpenSpec guide](openspec/README.md) | ||
| - [Mini site brief](briefs/mini-site-plan.md) | ||
| - [Page copy brief](briefs/page-copy-starter.md) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| file_type: documentation | ||
| title: "Run Log - Awesome GitHub Site" | ||
| description: "Execution log for planning and proposal runs related to the Awesome GitHub website." | ||
| version: "1.0.0" | ||
| created_date: "2026-06-03" | ||
| last_updated: "2026-06-03" | ||
| status: active | ||
| stability: stable | ||
| domain: opsx | ||
| owners: | ||
| - Ash Shaw | ||
| tags: | ||
| - planning | ||
| - opsx | ||
| - issues | ||
| - website | ||
| --- | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| # Run Log | ||
|
|
||
| ## Instructions | ||
|
|
||
| For each `/opsx:propose` run or planning pass, append a short entry using the pattern below. | ||
|
|
||
| ```markdown | ||
| ### YYYY-MM-DD HH:MM TZ - <entry-key> | ||
| - command: `<command-or-n/a>` | ||
| - expected-template: `<issue-template-or-n/a>` | ||
| - result: `success | failed | partial` | ||
| - github-issue-url: `<url-or-TBD>` | ||
| - labels-applied: `[label1, label2, ...]` | ||
| - notes: `<short summary of what changed or blocked progress>` | ||
| ``` | ||
|
|
||
| ## Entries | ||
|
|
||
| ### 2026-06-03 00:00 Europe/Warsaw - setup | ||
|
|
||
| - command: `n/a` | ||
| - expected-template: `n/a` | ||
| - result: `success` | ||
| - github-issue-url: `n/a` | ||
| - labels-applied: `[]` | ||
| - notes: `Project plan initialised. Phase 1 and phase 2 paths are now separated and ready for issue drafting.` | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,64 @@ | ||||||||||||||
| --- | ||||||||||||||
| file_type: documentation | ||||||||||||||
| title: "Mini Site Plan" | ||||||||||||||
| description: "Phase 1 information architecture and content requirements for the initial Awesome GitHub website." | ||||||||||||||
| version: "1.0.0" | ||||||||||||||
| created_date: "2026-06-03" | ||||||||||||||
| last_updated: "2026-06-03" | ||||||||||||||
| status: active | ||||||||||||||
| stability: draft | ||||||||||||||
| domain: website | ||||||||||||||
| owners: | ||||||||||||||
| - Ash Shaw | ||||||||||||||
| tags: | ||||||||||||||
| - planning | ||||||||||||||
| - content | ||||||||||||||
| - website | ||||||||||||||
| - phase-1 | ||||||||||||||
| --- | ||||||||||||||
|
coderabbitai[bot] marked this conversation as resolved.
|
||||||||||||||
|
|
||||||||||||||
| # Mini Site Plan | ||||||||||||||
|
|
||||||||||||||
| ## Purpose | ||||||||||||||
|
|
||||||||||||||
| Create a compact website that explains the project in a small, launchable package. | ||||||||||||||
|
|
||||||||||||||
| The first release should: | ||||||||||||||
|
|
||||||||||||||
| - give visitors an immediate overview | ||||||||||||||
| - explain why the site exists | ||||||||||||||
| - provide a short, evidence-backed reference trail | ||||||||||||||
| - stay small enough to ship before any catalogue expansion | ||||||||||||||
|
|
||||||||||||||
| ## Proposed Pages | ||||||||||||||
|
|
||||||||||||||
| 1. `Home` - title, purpose, and a short value proposition. | ||||||||||||||
| 2. `Why this exists` - the problem, the approach, and the reason the site exists. | ||||||||||||||
| 3. `References` - source links, acknowledgements, and supporting material. | ||||||||||||||
|
|
||||||||||||||
| ## Content Principles | ||||||||||||||
|
|
||||||||||||||
| - Keep every claim short and sourceable. | ||||||||||||||
| - Separate the launchable MVP from the broader phase 2 vision. | ||||||||||||||
| - Keep the tone direct and practical. | ||||||||||||||
| - Use the site to explain the project, not to repeat the full planning history. | ||||||||||||||
|
|
||||||||||||||
| ## Required Site Assets | ||||||||||||||
|
|
||||||||||||||
| - a concise site title and subtitle | ||||||||||||||
| - simple top navigation | ||||||||||||||
| - a references section with source links | ||||||||||||||
| - a lightweight footer with acknowledgements | ||||||||||||||
|
|
||||||||||||||
| ## Source Inputs | ||||||||||||||
|
|
||||||||||||||
| - `../../../../../wceu-2026/website/mini-site-plan.md` | ||||||||||||||
| - `../../../../../wceu-2026/website/page-copy-starter.md` | ||||||||||||||
| - `../../../../../wceu-2026/website/` | ||||||||||||||
|
Comment on lines
+55
to
+57
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Converting these plain text relative paths into actual markdown links will make them clickable and significantly improve navigation and developer experience.
Suggested change
|
||||||||||||||
| - `https://github.com/github/awesome-copilot/tree/main/website` | ||||||||||||||
|
|
||||||||||||||
| ## Alignment Notes | ||||||||||||||
|
|
||||||||||||||
| - Treat the reference site as a structural guide, not a copy target. | ||||||||||||||
| - Normalise talk-centric wording into site-centric wording. | ||||||||||||||
| - Keep phase 1 small so it can ship independently. | ||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| file_type: documentation | ||
| title: "Page Copy Starter" | ||
| description: "Draft copy scaffolding for the Awesome GitHub phase 1 pages." | ||
| version: "1.0.0" | ||
| created_date: "2026-06-03" | ||
| last_updated: "2026-06-03" | ||
| status: active | ||
| stability: draft | ||
| domain: website | ||
| owners: | ||
| - Ash Shaw | ||
| tags: | ||
| - planning | ||
| - copy | ||
| - website | ||
| - phase-1 | ||
| --- | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| # Page Copy Starter | ||
|
|
||
| ## Home | ||
|
|
||
| `Awesome GitHub` is a compact, GitHub-led website that explains how LightSpeed uses the `.github` repository as a practical control plane for planning, governance, and AI-assisted workflows. | ||
|
|
||
| The first release focuses on a small, usable site that can ship quickly and then grow into a fuller catalogue-style experience. | ||
|
|
||
| ## Why this exists | ||
|
|
||
| Repositories often become archives of files and workflows. | ||
|
|
||
| This project treats `.github` as an operating layer instead: | ||
|
|
||
| - templates and issue flows stay consistent | ||
| - planning becomes easier to follow | ||
| - governance stays visible | ||
| - the site can evolve without losing its source-backed footing | ||
|
|
||
| ## References | ||
|
|
||
| This site is informed by the open structure of `github/awesome-copilot` and by the LightSpeed planning material that shaped the first site brief. | ||
|
|
||
| The references page should point to the key source documents, the repo history that supports the claims, and any acknowledgements that help explain the design direction. | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,58 @@ | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
| file_type: documentation | ||||||||||||||||||||||
| title: "OpenSpec Proposal Guide - Awesome GitHub Site" | ||||||||||||||||||||||
| description: "Guide for turning the Awesome GitHub phase plans into `/opsx:propose` inputs." | ||||||||||||||||||||||
| version: "1.0.0" | ||||||||||||||||||||||
| created_date: "2026-06-03" | ||||||||||||||||||||||
| last_updated: "2026-06-03" | ||||||||||||||||||||||
| status: active | ||||||||||||||||||||||
| stability: stable | ||||||||||||||||||||||
| domain: opsx | ||||||||||||||||||||||
| owners: | ||||||||||||||||||||||
| - Ash Shaw | ||||||||||||||||||||||
| tags: | ||||||||||||||||||||||
| - openspec | ||||||||||||||||||||||
| - opsx | ||||||||||||||||||||||
| - issues | ||||||||||||||||||||||
| - website | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
|
coderabbitai[bot] marked this conversation as resolved.
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| # OpenSpec Proposal Guide | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Purpose | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| This folder exists to support the issue proposal workflow for the Awesome GitHub site. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Use it after the planning docs are approved and the phase split is locked. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Expected Order | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ### Phase 1 | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| 1. Source audit and scope lock | ||||||||||||||||||||||
| 2. Phase 1 information architecture and page map | ||||||||||||||||||||||
| 3. Phase 1 copy normalisation | ||||||||||||||||||||||
| 4. MVP site scaffold and page build | ||||||||||||||||||||||
| 5. Validation and launch readiness | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ### Phase 2 | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| 1. Full information architecture and content model | ||||||||||||||||||||||
| 2. Layout and browsing system expansion | ||||||||||||||||||||||
| 3. Content migration and page population | ||||||||||||||||||||||
| 4. Search or discovery enhancements | ||||||||||||||||||||||
| 5. Visual polish, accessibility pass, and full launch validation | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Inputs | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - `../phase-1/README.md` | ||||||||||||||||||||||
| - `../phase-2/README.md` | ||||||||||||||||||||||
| - `../ISSUE_EXECUTION_PLAN.md` | ||||||||||||||||||||||
| - `../briefs/mini-site-plan.md` | ||||||||||||||||||||||
| - `../briefs/page-copy-starter.md` | ||||||||||||||||||||||
|
Comment on lines
+48
to
+52
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Converting these plain text relative paths into actual markdown links will make them clickable and significantly improve navigation and developer experience.
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Notes | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Keep phase 1 and phase 2 proposal files separate. | ||||||||||||||||||||||
| - Use the normalised briefs as the initial source for `/opsx:propose`. | ||||||||||||||||||||||
| - Update `./RUN_LOG.md` after each proposal run. | ||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.