Skip to content

Erin/edu 694 tiger data 101 publish all 101 academy pages - #490

Open
erinmikailstaples wants to merge 25 commits into
mainfrom
erin/edu-694-tiger-data-101-publish-all-101-academy-pages
Open

Erin/edu 694 tiger data 101 publish all 101 academy pages#490
erinmikailstaples wants to merge 25 commits into
mainfrom
erin/edu-694-tiger-data-101-publish-all-101-academy-pages

Conversation

@erinmikailstaples

@erinmikailstaples erinmikailstaples commented Sep 2, 2026 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Collaborator

Describe your changes

This pull request introduces the Tiger Data Academy course structure and navigation to the documentation site, including new authoring guidelines, sidebar integration, and a custom navigation component for Academy modules. It also documents the usage and requirements for the interactive KnowledgeCheck component, ensuring a consistent, pedagogically sound learning experience.

Key changes:

1. Tiger Data Academy Course Authoring Guidelines

  • Added .claude/skills/write-academy-course/SKILL.md, a comprehensive guide for creating new Academy courses and modules. It covers directory structure, module format, knowledge check requirements, Bloom's taxonomy for learning objectives, and best practices for interactive content and assessments.

2. Interactive KnowledgeCheck Component Documentation

  • Updated AGENTS.md to document the KnowledgeCheck React component, including its intended use (Academy courses only), required props, resource recommendation features, and a usage example for MDX modules.

3. Sidebar and Navigation Enhancements for Academy

  • Expanded the sidebar in astro.config.ts to include a detailed, nested structure for Tiger Data Academy courses and modules, specifically the "Tiger Data 101" course and its chapters.
  • Replaced the default Pagination component with a new, Academy-specific AcademyPageNavigation.astro component for pages under Tiger Data Academy.

4. Academy-Specific Page Navigation Component

  • Introduced src/components/AcademyPageNavigation.astro, which detects chapter boundaries and displays "Next Chapter" or "Next Page" navigation based on the user's progress through Academy modules, improving the learning flow and clarity for users.

These changes collectively establish a robust framework for building, navigating, and maintaining interactive, modular courses within the Tiger Data Academy section of the documentation.

Affected pages

Related Issues

If there is a related issue, please add it below (just put the number after the # below, and GitHub will automatically create a link):

Issue: #number

Checklist before requesting a review

  • - This is ready for review. If not, raise as a draft PR
  • - I have reviewed my changes.
  • - I have confirmed the content is technically accurate.
  • - I have tested any code that is added or updated on the latest available version.
  • - I have confirmed the content is free of typos or grammar errors.
  • - I have verified all images and videos are clear and match production (or dev for unreleased features).
  • - I have checked the component kitchen sink for any visual breakage (only needed if you changed components, styles, or dependencies). A link to this PR's own preview appears under Affected pages once the build deploys.
  • - This references a feature that is public. If not, add a note and we can schedule the merge for after the feature release.

@erinmikailstaples
add 101 course
31b1598
@erinmikailstaples
knowledge check module, update components
0dbf8a7
@erinmikailstaples
restructure: split working-with-time-series-data into multi-page module
8b37329 
- Create 5 individual pages under 'Working with Time-Series Data' section
- Pages: what-makes-data-time-series, characteristics, vs-relational, patterns, storage-solution
- Add page navigation (prev/next) automatically via sidebar structure
- Move knowledge check to final page only
- Update sidebar in astro.config.ts to show pages as grouped items
- Each page has ~2 min read time, total module ~8-10 minutes
@erinmikailstaples
feat: restructure all tiger-data-101 modules into multi-page sections
b2e2925 
- Convert 'What is TimescaleDB?' into 4 pages (problem, architecture, features, applications)
- Convert 'Hypertables' into 3 pages (definition, creation, partitioning+indexing)
- Convert 'Hypercore' into 3 pages (row vs columnar, methods, enabling)
- Convert 'Continuous Aggregates' into 3 pages (problem, refresh policies, knowledge check)
- Convert 'Putting TimescaleDB Into Action' into 3 pages (dev to prod, lifecycle, case studies)
- Convert 'Core Use Cases' into 3 pages (IoT/financial/analytics, industrial/APM, knowledge check)
- Update sidebar in astro.config.ts to show all new multi-page structures
- Each section now has page navigation (prev/next) automatically
- Knowledge checks appear only on final page of each module
- Total course now 27 individual pages with ~90 minutes total content
@erinmikailstaples
style: add styled module headers and next-section navigation to acade…
7014d15 
…my pages

- Replace plain text module headers with styled info boxes (light purple bg + left border accent)
- Shows course, section, and page read time in a compact, visually-distinct format
- Add styled 'Next' sections with arrow indicators → for within-module navigation
- Makes within-module navigation (⟹ styled boxes) visually distinct from course-level page nav
- Applied to all Tiger Data 101 subpages for consistent experience
@erinmikailstaples
update headers to all match under academy sections
79dbb54
@erinmikailstaples
style: upgrade 'next module' navigation to vibrant call-to-action boxes
7d63aff 
- Replace plain 'Next:' text with bold, colorful gradient boxes (purple → indigo)
- Add arrow indicator (→) and 'NEXT MODULE' label for visual prominence
- White text on gradient background with subtle shadow for depth
- Link title and description styled as coherent block
- Creates clear visual separation from standard page navigation
- Guides users through course progression with excitement and clarity
- Applied to all within-module transitions across Tiger Data 101 sections
@erinmikailstaples
enhance: make 'next page' buttons fully clickable with hover effect
b6e82a6 
- Wrap entire gradient box in <a> tag for full clickability
- Add smooth hover effect with enhanced shadow
- Change label from 'NEXT MODULE' to 'NEXT PAGE' for accuracy
- Users can now click anywhere on the box to proceed
@erinmikailstaples
feat: implement smart chapter-boundary detection for academy navigation
1b5b165 
- Create AcademyPageNavigation component that intelligently detects section boundaries
- When moving to next chapter: label shows 'Next Chapter' (bold, blue accent)
- When moving within chapter: label shows 'Next' (standard styling)
- Works alongside automatic page navigation from sidebar structure
- Chapter mapping for all Tiger Data 101 sections built into component
- Replaces default PageNavigation site-wide (works normally for other docs)
- Non-Academy pages use standard navigation behavior unchanged
@erinmikailstaples
fix: use Astro.url.pathname for chapter boundary detection
7cf5c77 
The component was using route?.pathname which doesn't exist in Starlight's route object.
The correct way is to use Astro.url.pathname to get the current page path.
This fixes chapter-boundary detection so 'Next Chapter' labels now display correctly.
@erinmikailstaples
refactor: improve knowledge check page formatting with right-aligned …
0aaa7f1 
…styled buttons

- Replace plain text 'Up Next' sections with right-aligned gradient styled buttons
- Add more descriptive context for each next chapter
- Consistent formatting across all knowledge check pages
- Buttons now include section titles and detailed descriptions
- Arrow positioned on right side for cleaner visual flow
@erinmikailstaples
style: standardize all 'next page' navigation across academy pages
96c0ec8 
Replace all remaining plain text 'Next:' sections with right-aligned
gradient styled buttons throughout Tiger Data 101 course:

- hypercore: enabling-and-best-practices.mdx
- working-with-time-series-data: characteristics, time-series-vs-relational,
  choosing-the-right-storage-solution
- what-is-timescaledb: features-and-comparison.mdx
- core-use-cases: industrial-apm-and-infrastructure.mdx

All navigation buttons now feature:
- Right-aligned gradient styling (purple to indigo)
- Descriptive section titles and context
- Arrow positioned on the right for visual flow
- Consistent max-width for readability
@erinmikailstaples
fix: remove markdown syntax from HTML styled buttons
ae0e62d 
Replace markdown bold syntax (**text**) with plain text in HTML div elements
to prevent unwanted <p> tag rendering and ensure consistent styling across
all next page/chapter buttons in Tiger Data 101 academy pages.

Affected pages:
- continuous-aggregates/knowledge-check.mdx
- putting-timescaledb-into-action/case-studies-and-knowledge-check.mdx
- hypercore/enabling-and-best-practices.mdx
- working-with-time-series-data: characteristics, time-series-vs-relational,
  choosing-the-right-storage-solution
- what-is-timescaledb/features-and-comparison.mdx
- core-use-cases/industrial-apm-and-infrastructure.mdx
@erinmikailstaples
fix: add margin reset to styled button content divs
1031745 
Add margin-top: 0 and margin: 0 to div elements inside styled buttons
to prevent <p> tag wrapping inconsistencies across all Academy pages.
Ensures consistent clean spacing in all next page/chapter buttons.
@erinmikailstaples
fix: update refresh-policies page to use right-aligned styled button
9ad8a60 
Update the old-style left-aligned button on refresh-policies-and-hierarchies
to match the new right-aligned gradient button format with proper styling,
title, and description for consistency across all Academy pages.
@erinmikailstaples
fix: update features-and-comparison navigation to match styled button…
89d4470 
… format

Replace AcademyPageNavigation component with styled gradient button
and expand it to full width to match other Academy page navigation.
@erinmikailstaples
update menu items
b0d6fc4
@erinmikailstaples
erinmikailstaples requested a review from a team September 2, 2026 16:32
@vercel

vercel Bot commented Sep 2, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
tiger-data-docs Ready Ready Preview Sep 2, 2026 5:28pm UTC

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

⚠️ Checklist Incomplete

Please complete all checklist items in the PR description before requesting review.

Unchecked items:

  • This is ready for review
  • I have reviewed my changes
  • I have confirmed the content is technically accurate
  • I have tested any code that is added or updated
  • I have confirmed the content is free of typos or grammar errors
  • I have verified all images and videos are clear and match production
  • This references a feature that is public

Tip: If an item isn't relevant to your PR, mark it as checked and add "n/a" next to it.

@erinmikailstaples erinmikailstaples self-assigned this Sep 2, 2026
@erinmikailstaples
update where variables were crashing out
fa2332e
@erinmikailstaples
update to latest
74a6031 
merge branch 'erin/edu-694-tiger-data-101-publish-all-101-academy-pages' of https://github.com/timescale/Tiger-Data-Docs into erin/edu-694-tiger-data-101-publish-all-101-academy-pages
@erinmikailstaples
Update tiger-data-101.mdx
b4897b8 
Signed-off-by: Erin Mikail Staples <54031531+erinmikailstaples@users.noreply.github.com>
@erinmikailstaples
Update resources.mdx
0114fe0 
Signed-off-by: Erin Mikail Staples <54031531+erinmikailstaples@users.noreply.github.com>
erinmikailstaples
erinmikailstaples commented Sep 2, 2026
View reviewed changes

@erinmikailstaples erinmikailstaples left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update constants

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@erinmikailstaples erinmikailstaples

Labels

Academy

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@erinmikailstaples