Skip to content

(docs): missing Nx monorepo dev commands and issue scoping guidance #42

@anakafeel

Description

@anakafeel

Describe the bug

The documentation has not been updated after migrating to an Nx monorepo. It still assumes a single-project setup and does not explain how to run dev servers for individual apps using Nx.

Additionally, there is no guidance on how to scope issues now that the repository contains (or will contain) multiple apps.

To Reproduce

Steps to reproduce the issue:

  1. Clone the repository.
  2. Follow the current README or docs to run the dev server.
  3. Observe that Nx-based commands (e.g. nx dev docs) are not documented.
  4. Open a new issue and note that there is no convention for scoping issues to specific apps.

Expected behavior

  • Documentation clearly explains how to run dev servers for each app in the monorepo using Nx.
  • Contributors know which commands to use for:
    • docs app
    • web app (future)
    • car app (future)
  • Issues can be easily scoped to parts of the monorepo using a consistent convention.
Image

Additional context

Proposed documentation updates:

  • Add a “Monorepo / Nx” section to the README or docs
  • Document dev commands, for example:
    • nx dev docs
    • nx build docs
    • nx graph
  • Add an issue scoping convention, such as:
    • (docs) Documentation-related issues
    • (web) Website-related issues
    • (car) Robotics / ROS / tooling issues
    • (infra) CI, tooling, repo-wide changes

This will significantly improve contributor experience now that the project is a monorepo.

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