Skip to content

Created Spira AI Connect documentation.#68

Open
destapickering-9504 wants to merge 2 commits into
mainfrom
feature/spiraaiconnect
Open

Created Spira AI Connect documentation.#68
destapickering-9504 wants to merge 2 commits into
mainfrom
feature/spiraaiconnect

Conversation

@destapickering-9504

Copy link
Copy Markdown
Collaborator

Adds the full doc for the new Spira AI Connect SpiraApp, covering setup and usage for all supported providers.

New doc:

  • Spira-AI-Connect.md
  • 17 screenshots in docs/SpiraApps/img/spiraaiconnect-*.png
  • Nav entry added to mkdocs.yml (between "Risks+" and "Task and Test Presets")

What the doc covers

  • REST API setup (OpenAI, Azure OpenAI, Groq, Mistral, Together AI, etc.)
  • AWS Bedrock setup (IAM user/group/policy walkthrough)
  • System and product settings configuration
  • Usage from requirements, test cases, tasks, and risks
  • Custom prompt configuration
  • Code generation with language/framework picker
  • Cross-region inference profile support

@simonhbor simonhbor left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One small correction to the IAM policy and a suggestion for an unimportant edit. Everything looks great!

Comment thread docs/SpiraApps/Spira-AI-Connect.md
Comment thread docs/SpiraApps/Spira-AI-Connect.md Outdated

@simonhbor simonhbor left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One other requested change - add some marketing stuff at the top (my suggestion is based on Adam's blog post)

Comment thread docs/SpiraApps/Spira-AI-Connect.md Outdated

@simonhbor simonhbor left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Approved. Should merge when we release the SpiraApp

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.

2 participants