Skip to content

Add user manual to GitProxy documentation site #1525

@kriswest

Description

@kriswest

Add a user-manual.mdx page to /website/docs/ covering:

  • How GitProxy works (ingress/egress flows with Mermaid diagrams)
  • Authentication (proxy credentials vs UI login)
  • Automated checks applied to contributions
  • Setting up forks (personal, shared, internal)
  • Git client configuration (identity, SSL, credentials)
  • Pushing through the proxy, requesting review, and pushing again after approval
  • Reviewing contributions
  • Troubleshooting common issues (credentials, blocked pushes, DCO sign-offs, SSL errors)

The manual should be written to be organisation-agnostic, with admonitions indicating where a deploying organisation's specific configuration will affect behaviour.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions