Skip to content

docs: no documented convention for how examples reference the core lib #253

@panz3r

Description

@panz3r

Context

Discovered during development of the showcase example (PR #252).

Problem

Existing examples pin a published version string (e.g. 2.0.3) for @forward-software/react-auth, but local development benefits from aliasing directly to the lib source. There is currently no documented convention for how example apps should reference the core library — whether via a published version, a workspace link, or a path alias.

Impact

Contributors adding or modifying examples don't have a clear pattern to follow, leading to inconsistent setups across the examples/ directory.

Proposed Action

Establish and document a convention (in CONTRIBUTING.md, AGENTS.md, or a dedicated examples README) for how example apps should reference the core lib — covering both local development (path aliases / workspace links) and the published package approach.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions