Skip to content

docs: polish repository presentation#39

Merged
fnayou merged 1 commit into
mainfrom
chore/polish-repo-presentation
Jun 25, 2026
Merged

docs: polish repository presentation#39
fnayou merged 1 commit into
mainfrom
chore/polish-repo-presentation

Conversation

@fnayou

@fnayou fnayou commented Jun 25, 2026

Copy link
Copy Markdown
Owner

Polish the repository presentation. No content rewrite; docs/ untouched.

Changes

  • README — added a compact centered banner (dotfiles-readme-banner.png) and a centered Documentation link at the top. Removed the old inline 📖 documentation line to avoid a duplicate link; the Documentation-section link is unchanged.
  • MkDocs — added the site logo to the Material theme (logo: assets/images/dotfiles-logo.png). mkdocs build --strict passes.
  • Assets — committed the generated dotfiles-logo.png, dotfiles-readme-banner.png, and dotfiles-social-preview.png.

Repository metadata (via gh CLI)

  • Description: already clear — left unchanged.
  • Homepage: already set to https://fnayou.github.io/dotfiles/ — unchanged.
  • Topics added: shell, endeavouros, taskfile. Skipped stow (covered by gnu-stow) and archlinux (covered by arch-linux).

Social preview — manual step required

gh CLI cannot set the social preview image. Upload it manually:
Settings → General → Social preview → Edit → Upload website/assets/images/dotfiles-social-preview.png

Add a compact centered banner and documentation link to the top of the
README, add the site logo and a favicon (generated from the logo) to the
MkDocs Material theme, and commit the generated visual assets.

docs/ untouched.
@fnayou fnayou force-pushed the chore/polish-repo-presentation branch from 229f8da to 55da1bf Compare June 25, 2026 23:17
@fnayou fnayou merged commit fc768d3 into main Jun 25, 2026
2 checks passed
@fnayou fnayou deleted the chore/polish-repo-presentation branch June 25, 2026 23:19
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