Skip to content

Improve portfolio presentation on docs site#164

Merged
astomodynamics merged 1 commit into
masterfrom
feat/docs-portfolio-theme
Apr 3, 2026
Merged

Improve portfolio presentation on docs site#164
astomodynamics merged 1 commit into
masterfrom
feat/docs-portfolio-theme

Conversation

@astomodynamics
Copy link
Copy Markdown
Owner

@astomodynamics astomodynamics commented Apr 3, 2026

Summary

Improve the GitHub Pages presentation of the Python portfolio and add a
customized docs theme with a navy-and-gold visual direction.

Changes

  • reshape docs/python_portfolio.md into a web-first gallery with a hero
    section and responsive portfolio cards
  • add a custom MkDocs stylesheet for header, buttons, background, and
    portfolio-specific styling
  • configure the Material theme to use the custom palette and stylesheet
  • surface the portfolio more prominently from the docs landing page

Test Plan

  • source .venv/bin/activate && uvx --from mkdocs --with mkdocs-material mkdocs build --strict
  • git diff --check

How to Test

  1. Run source .venv/bin/activate && uvx --from mkdocs --with mkdocs-material mkdocs build --strict.
  2. Open the generated site locally and check the landing page and portfolio page.
  3. Confirm the portfolio GIFs appear in responsive cards and the site styling
    uses the new navy-and-gold direction.

Reshape the portfolio page into a web-first gallery and add a custom navy-and-gold site theme.
Also surface the portfolio more clearly from the docs landing page.
@astomodynamics astomodynamics merged commit a75038b into master Apr 3, 2026
1 of 2 checks passed
@astomodynamics astomodynamics deleted the feat/docs-portfolio-theme branch April 3, 2026 03:11
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a0aa761356

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/python_portfolio.md
</p>
<p>
<a class="md-button md-button--primary" href="../python/">Python package guide</a>
<a class="md-button" href="https://github.com/astomodynamics/cddp-cpp/tree/master/examples">Browse examples</a>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Link examples button to active default branch

The new “Browse examples” CTA hard-codes tree/master, but this repository is on main (no master ref), so the button leads users to a 404 instead of the examples directory. This breaks the primary outbound action in the new hero section; use tree/main (or a branch-agnostic URL strategy) so the docs link stays valid.

Useful? React with 👍 / 👎.

@astomodynamics astomodynamics restored the feat/docs-portfolio-theme branch April 3, 2026 03:13
@astomodynamics astomodynamics deleted the feat/docs-portfolio-theme branch April 3, 2026 18:23
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