镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

Add API key generation instructions linking to console.solidrust.ai #9

Closed

Description

@suparious

Description

Documentation references getting an API key from console.solidrust.ai but doesn't provide clear instructions on how to generate one. New users need step-by-step guidance.

Current State

Quick Start page says:

Prerequisites: An API key from console.solidrust.ai

But provides no instructions on:

  1. How to sign up
  2. Where to find API key generation
  3. How to manage/rotate keys

Proposed Addition

Create a new page: src/content/docs/getting-started/api-keys.md

Content Should Include:

  1. Getting Started

    • Link to console.solidrust.ai
    • Sign up process
    • Initial navigation
  2. Generating API Keys

    • Step-by-step with screenshots (optional)
    • Key naming best practices
    • Where keys are displayed
  3. Security Best Practices

    • Never commit keys to git
    • Use environment variables
    • Key rotation schedule
  4. Managing Keys

    • Viewing existing keys
    • Revoking keys
    • Regenerating keys
  5. Troubleshooting

    • 401 Unauthorized errors
    • Key validation issues

Acceptance Criteria

  • New API Keys documentation page created
  • Added to "Getting Started" section in sidebar
  • Linked from quickstart.md prerequisites
  • Includes security best practices
  • Clear, actionable instructions

Priority

MEDIUM - Helps onboarding, but users can currently figure it out through the console UI.

Activity

  1. suparious commented on Jan 18, 2026

    @suparious
    MemberAuthor

    Resolved: API Key Generation Instructions Added

    Created comprehensive API key documentation at src/content/docs/getting-started/api-keys.md covering:

    Content Added:

    • Overview - Explains API key purpose and PAM Platform role
    • Obtaining API Keys - Step-by-step console.solidrust.ai instructions with screenshots placeholder
    • Using API Keys - Header format, Python/JavaScript/cURL examples
    • Key Management Best Practices - Environment variables, rotation, security guidelines
    • Troubleshooting - Common errors (401/403) with solutions
    • Rate Limits - Link to rate limits documentation
    • Support - Contact information

    Changes:

    • src/content/docs/getting-started/api-keys.md - New comprehensive guide
    • astro.config.mjs - Added "API Keys" to sidebar navigation under Getting Started

    Commits:

    • 3b76f8b0f9751c4e53f4e7fbb70e3d450f903e43 - docs: Add comprehensive API key generation and usage guide
    • e26a3855d488d9d202f61995b24a2fdc27cdc16b - docs: Add API Keys to sidebar navigation

    The documentation is now accessible at /getting-started/api-keys/ in the docs site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions