Skip to content

docs(domain): add domain-settings guide for owned-domain management [GDDEVPLAT-481] - #353

Merged
jpage-godaddy merged 2 commits into
mainfrom
feature/GDDEVPLAT-481-domain-settings-guide
Nov 2, 2026
Merged

jpage-godaddy merged 2 commits into
mainfrom
feature/GDDEVPLAT-481-domain-settings-guide

Conversation

@rts1-godaddy

Copy link
Copy Markdown
Collaborator

https://godaddy-corp.atlassian.net/browse/GDDEVPLAT-481

Why

We ship gddy guide domain-purchase for quote/register, and gddy guide dns for DNS records, but nothing for managing a domain you already own. After auto-renew set and transfer-lock set (GDDEVPLAT-320), customers and AI agents need a how-to for post-purchase settings. Extending the purchase guide would mix two different jobs; a dedicated domain-settings topic keeps discovery clear via gddy guide.

What changed

  • Adds rust/src/domain/guides/domain-settings.md covering domain list / get, auto-renew set, transfer-lock set (with an AI assistants: note on unlock), nameserver set, and domain operation status polling.
  • Registers the guide on the Domains module next to domain-purchase so it appears as gddy guide domain-settings.
  • Cross-links to domain-purchase and dns; does not rewrite the purchase guide.

Testing

Verification

cd rust
cargo check --workspace
cargo clippy --workspace -- -D warnings
cargo test --workspace
cargo fmt --check
./scripts/check-module-size.sh

Manual steps to exercise this change

  1. Build from this branch:
    cd rust && cargo build -p godaddy-cli
  2. Confirm the topic is listed:
    ./target/debug/gddy guide
    Expect domain-settings with summary about owned-domain settings (alongside domain-purchase).
  3. Render the guide:
    ./target/debug/gddy guide domain-settings -o human
    ./target/debug/gddy guide domain-settings --output json
    Check sections for inspect, auto-renew, transfer lock, nameservers, async operations, and related guides.
  4. Spot-check that command help still matches the guide examples:
    ./target/debug/gddy domain auto-renew set --help
    ./target/debug/gddy domain transfer-lock set --help
    ./target/debug/gddy domain nameserver set --help
    ./target/debug/gddy domain operation status --help

No live API calls are required for this docs-only change.

Made with Cursor

…GDDEVPLAT-481]

Ship gddy guide domain-settings covering list/get, auto-renew, transfer-lock,
nameserver set, and async operation polling, with cross-links to purchase and DNS.

Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI left a comment

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.

🟢 Approval recommended

No active review issues are reported for the new domain-settings guide and its registration.

No open issues 🎉

What changed in this PR

Adds a dedicated domain-settings guide for managing domains customers already own, complementing the existing purchase and DNS guides.

Changes:

  • Documents domain inspection, auto-renewal, transfer lock, nameserver updates, and operation-status polling.
  • Includes an explicit confirmation note for AI assistants before unlocking a domain for transfer.
  • Registers the guide alongside domain-purchase and links to related guides.
File Description
rust/​src/​domain/​mod.rs Registers the domain-settings guide on the Domains module.
rust/​src/​domain/​guides/​domain-settings.md Adds owned-domain management instructions and command examples.

Review effort: Balanced

Co-authored-by: Jacob Page <85361835+jpage-godaddy@users.noreply.github.com>
@jpage-godaddy
jpage-godaddy merged commit fcba0b8 into main Nov 2, 2026
5 checks passed
@jpage-godaddy
jpage-godaddy deleted the feature/GDDEVPLAT-481-domain-settings-guide branch November 2, 2026 22:05
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