Setup guide design and sidebar structure#5
Setup guide design and sidebar structure#5MartinBozhilov-coh wants to merge 4 commits intomasterfrom
Conversation
bf6e2d2 to
e97f203
Compare
| </div> | ||
|
|
||
| <CourseCard | ||
| title={`0${index + 1}. ${heading}`} |
There was a problem hiding this comment.
IMO we don't need to add the number of the topic in the title anymore as far as the timeline shows the number on the left.
| main:has(.hero) footer { | ||
| display: none; | ||
| } |
There was a problem hiding this comment.
IMO is better idea to scope the styles in a separate component that will be used in the index.mdx directly because in the custom.css you are globally overwriting the styles so all the .hero pages for example will get the new styles.
And also for the index.mdx you can directly import the new component that will render the timeline with topics and leave index.mdx clean.
---
title: Mastering Gameface
description: Your step-by-step journey to building high-performance, cinematic game interfaces using HTML5 technology!.
template: splash
hero:
tagline: Your step-by-step journey to building high-performance, cinematic game interfaces using HTML5 technology!
actions:
- text: Get started
link: /introduction/hello-world
icon: right-arrow
- text: Resume
link: https://starlight.astro.build
icon: external
variant: secondary
---
import Timeline from '../../components/Timeline.astro';
<Timeline/>
| export default defineConfig({ | ||
| integrations: [ | ||
| starlight({ | ||
| title: 'My Docs', |
There was a problem hiding this comment.
Marti's docs :D Can we change the name?
| integrations: [ | ||
| starlight({ | ||
| title: 'My Docs', | ||
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }], |
There was a problem hiding this comment.
Remove for now. If we add a repo with samples from the docs we can add the social back. Instead add the following icons that will lead to the site and get in touch form:
social: [
{
icon: 'laptop',
label: 'Site',
href: 'https://coherent-labs.com/',
},
{
icon: 'email',
label: 'Email',
href: 'https://coherent-labs.com/get-in-touch'
},
],
| social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }], | ||
| plugins: [ | ||
| ...coherentTheme({ | ||
| documentationSearchTag: 'Gameface content guide', |
There was a problem hiding this comment.
Maybe rename it to 'UI workflow guide'
There was a problem hiding this comment.
Pull request overview
Adds a new Astro + Starlight documentation site under content-creation-guide/, including a splash-style landing page with custom components and a sidebar autogenerated from a central “course content” data list.
Changes:
- Bootstraps an Astro/Starlight project (config, TS config, content collections, base docs structure).
- Introduces landing-page components (
AuroraGlowBg,CoursesTimeline,CourseCard) driven bysrc/data/content.ts. - Configures Starlight +
coherent-docs-themeand generates the sidebar from thecontentlist.
Reviewed changes
Copilot reviewed 16 out of 18 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| content-creation-guide/tsconfig.json | Adds strict Astro TypeScript configuration. |
| content-creation-guide/src/data/content.ts | Defines timeline/sidebar topic metadata and links. |
| content-creation-guide/src/content/docs/index.mdx | Adds splash landing page wiring the new components. |
| content-creation-guide/src/content/docs/introduction/hello-world.mdx | Adds initial placeholder doc page. |
| content-creation-guide/src/content/docs/core-concepts/hello-world.mdx | Adds initial placeholder doc page. |
| content-creation-guide/src/content/docs/ecosystem-tools/hello-world.mdx | Adds initial placeholder doc page. |
| content-creation-guide/src/content.config.ts | Registers Starlight docs collection loader/schema. |
| content-creation-guide/src/components/CoursesTimeline.astro | Renders the timeline from content metadata. |
| content-creation-guide/src/components/CourseCard.astro | Adds a clickable card UI used by the timeline. |
| content-creation-guide/src/components/AuroraGlowBg.astro | Adds decorative animated background on landing page. |
| content-creation-guide/astro.config.mjs | Configures Starlight integration, theme plugin, and sidebar generation. |
| content-creation-guide/package.json | Adds Astro/Starlight + theme dependencies and scripts. |
| content-creation-guide/README.md | Adds default Starlight starter README. |
| content-creation-guide/public/favicon.svg | Adds favicon. |
| content-creation-guide/src/assets/houston.webp | Adds an image asset. |
| content-creation-guide/.gitignore | Adds standard Astro/node ignores. |
| content-creation-guide/.vscode/launch.json | Adds a VS Code launch config for astro dev. |
| content-creation-guide/.vscode/extensions.json | Recommends the Astro VS Code extension. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| import { Card, CardGrid, Steps } from '@astrojs/starlight/components'; | ||
| import CourseCard from '../../components/CourseCard.astro'; | ||
| import {content} from '../../data/content.ts'; |
There was a problem hiding this comment.
These imports appear unused in this page (Card, CardGrid, Steps, CourseCard, and content are not referenced below). If astro check/linting is enabled, unused imports can fail CI or at least add noise. Remove unused imports or use them as intended.
| import { Card, CardGrid, Steps } from '@astrojs/starlight/components'; | |
| import CourseCard from '../../components/CourseCard.astro'; | |
| import {content} from '../../data/content.ts'; |
content-creation-guide/README.md
Outdated
| # Starlight Starter Kit: Basics | ||
|
|
||
| [](https://starlight.astro.build) | ||
|
|
||
| ``` | ||
| npm create astro@latest -- --template starlight | ||
| ``` | ||
|
|
||
| > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! | ||
|
|
There was a problem hiding this comment.
This README is still the default Starlight starter template (including instructions to delete the file) and doesn’t describe this repository’s actual purpose/setup. If this project is meant to be maintained long-term, replace this with a guide-specific README (how to run/build, where content lives, sidebar/content conventions, etc.).
No description provided.