Skip to content

Comments

[Repo Assist] Fix #626: Add \{\{fsdocs-logo-alt}} substitution for customizable logo alt text#996

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
repo-assist/fix-626-fsdocs-logo-alt-03005f41899c2512
Draft

[Repo Assist] Fix #626: Add \{\{fsdocs-logo-alt}} substitution for customizable logo alt text#996
github-actions[bot] wants to merge 1 commit intomainfrom
repo-assist/fix-626-fsdocs-logo-alt-03005f41899c2512

Conversation

@github-actions
Copy link
Contributor

🤖 This is an automated pull request from Repo Assist, an AI assistant for this repository.

Closes #626

Problem

The default _template.html hardcoded alt="Header menu logo" for the header logo image, making it impossible to customise the alt text for accessibility without overriding the entire template.

Fix

Added a {{fsdocs-logo-alt}} template substitution backed by the (FsDocsLogoAlt) MSBuild property, defaulting to "Logo".

Changes:

  • Templating.fs: add `ParamKeys.``fsdocs-logo-alt```
  • ProjectCracker.fs: read (FsDocsLogoAlt) MSBuild property; propagate through merged project info; map to fsdocs-logo-alt parameter (default "Logo")
  • docs/_template.html: use {{fsdocs-logo-alt}} instead of hardcoded "Header menu logo"
  • docs/styling.md: document the new substitution
  • RELEASE_NOTES.md: add entry under [Unreleased]

Usage example:

(FsDocsLogoAlt)FSharp.Formatting documentation logo(/FsDocsLogoAlt)

Test Status

  • ✅ Build succeeded (0 errors, 4 pre-existing vulnerability warnings)
  • ✅ 346 tests passed, 6 skipped, 0 failed across all test suites
    • FSharp.Markdown.Tests: 179 passed
    • FSharp.CodeFormat.Tests: 20 passed
    • FSharp.Literate.Tests: 79 passed
    • FSharp.ApiDocs.Tests: 68 passed

Generated by Repo Assist

To install this workflow, run gh aw add githubnext/agentics/workflows/repo-assist.md@828ac109efb43990f59475cbfce90ede5546586c. View source at https://github.com/githubnext/agentics/tree/828ac109efb43990f59475cbfce90ede5546586c/workflows/repo-assist.md.

Add a configurable `{{fsdocs-logo-alt}}` template substitution for the
header logo's alt text, backed by the `<FsDocsLogoAlt>` MSBuild property.
The default value is 'Logo'.

Previously the default template hardcoded alt="Header menu logo", which
was not customizable.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Contributor Author

✅ Pull request created: #996

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Accessibility: consider providing an alt for logo with fsdocs-logo-alt content replacer

0 participants