Skip to content

feat(docs): add sparked admin template documentation - #1435

Open
geromegrignon wants to merge 2 commits into
mainfrom
feat/docs-sparked-template
Open

feat(docs): add sparked admin template documentation#1435
geromegrignon wants to merge 2 commits into
mainfrom
feat/docs-sparked-template

Conversation

@geromegrignon

Copy link
Copy Markdown
Contributor

Description

Related issues

Fixes #

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that changes the public API)
  • Documentation only
  • Refactor, test, or chore (no user-facing change)

Breaking changes

None

Test plan

  • npm run build
  • npm test
  • npm run lint
  • Verified in the demo app (if applicable)

Checklist

  • Issue discussed or bug clearly described (link issue when applicable)
  • Tests added or updated for behavioral changes
  • Documentation updated (README, JSDoc, migration notes as needed)
  • Public API changes documented; breaking changes called out
  • CHANGELOG updated (if the repository maintains one and the change is user-facing)
  • Commit messages follow Conventional Commits
  • I agree to follow the OpenNG Foundation Code of Conduct

Additional context

Copilot AI lite review requested due to automatic review settings August 4, 2026 07:47

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a new “Templates” area to the Optimus UI docs site and landing page to highlight the Sparked admin template, including routing, navigation, and supporting styles/SEO updates.

Changes:

  • Introduces a new /templates docs page with Sparked template documentation and links.
  • Adds a new landing-page “Application Template” section showcasing Sparked (with new layout styles).
  • Wires the new page into routing, menu/footer navigation, sitemap, and the LLM docs build script exclusions.

Reviewed changes

Copilot reviewed 14 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
apps/docs/utils/constants.ts Adds Sparked demo/repo URL constants for reuse across docs and landing.
apps/docs/scripts/build-llm-docs.mjs Excludes templates from component-doc generation to avoid misclassification.
apps/docs/router/routes.txt Adds /templates to the route list.
apps/docs/router/app.routes.ts Registers lazy-loaded templates route.
apps/docs/public/sitemap.xml Adds /templates to sitemap for SEO/discoverability.
apps/docs/pages/templates/routes.ts Defines the route to the Templates page component.
apps/docs/pages/templates/index.ts Implements the Templates page wrapper using AppDoc.
apps/docs/pages/landing/templatesection.component.ts New landing section showcasing Sparked and linking to demo/repo.
apps/docs/pages/landing/landing.component.ts Includes the new landing template section component.
apps/docs/pages/landing/landing.component.html Renders <template-section /> on the landing page.
apps/docs/pages/landing/footersection.component.ts Adds Templates navigation and a Sparked Demo footer link.
apps/docs/doc/templates/sparked-doc.ts New Sparked documentation content and CTA buttons.
apps/docs/assets/styles/layout/landing/_templates.scss Reworks landing template section styles for the new layout.
apps/docs/assets/data/menu.json Adds Templates entry to the docs menu/navigation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread apps/docs/pages/landing/templatesection.component.ts Outdated
Comment thread apps/docs/doc/templates/sparked-doc.ts Outdated
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.

2 participants