Skip to content

docs: fix the flake init template attribute#1388

Merged
brianmcgillion merged 1 commit intotiiuae:mainfrom
elmankku:fix/flake-init-template-name
Sep 9, 2025
Merged

docs: fix the flake init template attribute#1388
brianmcgillion merged 1 commit intotiiuae:mainfrom
elmankku:fix/flake-init-template-name

Conversation

@elmankku
Copy link
Copy Markdown
Contributor

@elmankku elmankku commented Sep 9, 2025

When following the "Getting Started" on the project home page, the command fails to a missing attribute. Update the template name to a valid template target.

Description of Changes

Type of Change

  • New Feature
  • Bug Fix
  • Improvement / Refactor

Related Issues / Tickets

Checklist

  • Clear summary in PR description
  • Detailed and meaningful commit message(s)
  • Commits are logically organized and squashed if appropriate
  • Contribution guidelines followed
  • Ghaf documentation updated with the commit - https://tiiuae.github.io/ghaf/
  • Author has run make-checks and it passes
  • All automatic GitHub Action checks pass - see actions
  • Author has added reviewers and removed PR draft status

Testing Instructions

Applicable Targets

  • Orin AGX aarch64
  • Orin NX aarch64
  • Lenovo X1 x86_64
  • Dell Latitude x86_64
  • System 76 x86_64

Installation Method

  • Requires full re-installation
  • Can be updated with nixos-rebuild ... switch
  • Other: nix build .#doc

Test Steps To Verify:

  1. Navigate to https://ghaf.tii.ae/ - try running the command on Getting Started-box. Fails to
    error: flake 'github:tiiuae/ghaf' does not provide attribute 'templates.boilerplate' or 'boilerplate'
  2. Apply the patch, rebuild the docs: nix build .#doc
  3. Open the index.html on the updated docs and run the (updated) command -> initializes a flake from the template.

When following the "Getting Started" on the project home page, the
command fails to a missing attribute. Update the template name to
a valid template target.

Signed-off-by: Markku Ahvenjärvi <mankku@gmail.com>
@brianmcgillion
Copy link
Copy Markdown
Collaborator

thanks @elmankku. and you highlight an issue there. it is really not the first step for approaching ghaf. :( Need to do an overhaul of the docs

@brianmcgillion brianmcgillion merged commit 8927e83 into tiiuae:main Sep 9, 2025
27 of 28 checks passed
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.

3 participants