project

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package project provides access to project-root files and directory README templates from embedded assets.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func File

func File(name string) ([]byte, error)

File reads a project-root file by name from the embedded filesystem.

These files are deployed to the project root (not .context/) by dedicated handlers during initialization.

Parameters:

  • name: Filename (e.g., "IMPLEMENTATION_PLAN.md")

Returns:

  • []byte: File content
  • error: Non-nil if the file is not found or read fails

func Readme

func Readme(dir string) ([]byte, error)

Readme reads a project directory README template by directory name.

Templates are stored as project/<dir>-README.md in the embedded filesystem.

Parameters:

  • dir: Directory name (e.g., "specs", "ideas")

Returns:

  • []byte: README.md content for the directory
  • error: Non-nil if the file is not found or read fails

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL