Skip to content

docs: rename carbide/forge → NICo in documentation and design materials#1974

Open
shayan1995 wants to merge 1 commit into
NVIDIA:mainfrom
shayan1995:feat/rename-docs
Open

docs: rename carbide/forge → NICo in documentation and design materials#1974
shayan1995 wants to merge 1 commit into
NVIDIA:mainfrom
shayan1995:feat/rename-docs

Conversation

@shayan1995
Copy link
Copy Markdown
Contributor

Description

Apply the carbide/forge → NICo rename across documentation files: top-level markdown (AGENTS, CONTRIBUTING, README, STYLE_GUIDE), crate-level READMEs and DEVELOPMENT.md, metrics fixture files, and docs/ (architecture, design, playbooks, manuals, getting-started, static assets). File-name renames for carbide-* / forge_* static assets are included.

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Related Issues (Optional)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Additional Notes

Scope: docs/, root .md, crates//README.md, crates//DEVELOPMENT.md, crates//tests//*.txt metrics fixtures. Out of scope (covered by other rename branches): helm/, lints/, rest-api/, .github/, Cargo.toml, crates//*.rs.

@shayan1995 shayan1995 requested review from a team and Coco-Ben as code owners May 28, 2026 00:35
@ajf
Copy link
Copy Markdown
Collaborator

ajf commented May 28, 2026

This looks OK from a docs perspective.

I assume that in most of these places the docs don't match the code or the artifact names, so this will be updated in subsequent PRs?

@shayan1995 shayan1995 force-pushed the feat/rename-docs branch 2 times, most recently from 25e8ed1 to 08bf313 Compare May 28, 2026 06:20
@shayan1995
Copy link
Copy Markdown
Contributor Author

@ajf yes the name changes is coming in a subsequent PR.

@sydneyl-nvidia
Copy link
Copy Markdown
Contributor

sydneyl-nvidia commented May 28, 2026

@ajf yes the name changes is coming in a subsequent PR.

I assume that "name changes" means code here (or manifests, or both)? The above was a little ambiguous to me, just want to be certain.

Apply the carbide/forge → NICo rename across documentation only: top-level
markdown (AGENTS, CONTRIBUTING, README, STYLE_GUIDE), per-crate
README.md / DEVELOPMENT.md, and the full docs/ tree (architecture, design,
playbooks, manuals, getting-started, static assets). File-name renames for
carbide-* / forge_* static assets are included.

Substitutions applied (regex, ordered so PascalCase wins before brand-casing):
  CARBIDE          -> NICO
  FORGE            -> NICO
  Carbide(?=[A-Z]) -> Nico    (PascalCase identifier prefix)
  Forge(?=[A-Z])   -> Nico
  Carbide          -> NICo    (brand-casing standalone)
  Forge            -> NICo
  carbide          -> nico
  forge            -> nico

Scope intentionally excludes test metric fixtures (crates/**/tests/**/*.txt
and crates/**/fixtures/**/*.txt). Those are pinned-output comparisons
against live metrics emitted by production code, so they must be renamed
together with the agent/api source rename — they ride along with the code
branch instead of docs.

Out of scope (covered by other rename branches): helm/, lints/, rest-api/,
.github/, Cargo.toml, crates/**/*.rs.
- `nicocli` installed (`make nico-cli` from the infra-controller-rest repo) and reachable on `$PATH`.

> **Note on CLI naming**: Older docs reference `carbidecli` (built via `make carbide-cli`). It's the same source under a previous name. This guide uses `nicocli` (built via `make nico-cli`) consistently.
> **Note on CLI naming**: Older docs reference `nicocli` (built via `make nico-cli`). It's the same source under a previous name. This guide uses `nicocli` (built via `make nico-cli`) consistently.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't make sense with the rename :-) We could probably remove this note as part of the PR.

### NICo Metadata Service

The Forge Metadata Service (FMDS) exposes instance metadata to tenants from the DPU. Tenants can use FMDS to retrieve information such as the Machine ID and boot or operating system metadata for their instance. FMDS runs on the DPU rather than on the host, so its responses are trusted independently of the host OS.
The NICo Metadata Service (FMDS) exposes instance metadata to tenants from the DPU. Tenants can use FMDS to retrieve information such as the Machine ID and boot or operating system metadata for their instance. FMDS runs on the DPU rather than on the host, so its responses are trusted independently of the host OS.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably change "FDMS" acronym to "MDS".

Comment thread docs/glossary.md
This glossary focuses on NICo-specific concepts: terms that only make sense in the context of the NICo platform. Where a term has a general industry definition but carries additional NICo-specific meaning, this glossary explains the NICo-specific part.

<Note> You will encounter references to Forge, Carbide, and BMM in source code, CLI tool names, protobuf definitions, OpenAPI text, Helm charts, and image names. These were internal NVIDIA project names that preceded the current NICo branding. The documentation should use NICo names for product concepts, but many implementation artifacts still use legacy names such as `carbide-*`, `forge-*`, and `FORGE_*`. When this glossary references an artifact, role string, metric namespace, or configuration key, it preserves the name used by that interface.</Note>
<Note> You will encounter references to NICo, NICo, and BMM in source code, CLI tool names, protobuf definitions, OpenAPI text, Helm charts, and image names. These were internal NVIDIA project names that preceded the current NICo branding. The documentation should use NICo names for product concepts, but many implementation artifacts still use legacy names such as `nico-*`, `nico-*`, and `NICO_*`. When this glossary references an artifact, role string, metric namespace, or configuration key, it preserves the name used by that interface.</Note>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar comment to above. You could probably remove this note.

Comment thread docs/glossary.md
NVIDIA Cloud Partner. In NICo docs, NCP usually refers to an infrastructure provider operating NICo-managed environments for tenant workloads.

### Carbide
### NICo
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this entry.

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.

4 participants