Skip to content

docs: add comprehensive developer FAQ#547

Open
HusseinAdeiza wants to merge 1 commit into
TaceoLabs:mainfrom
HusseinAdeiza:docs/add-developer-faq
Open

docs: add comprehensive developer FAQ#547
HusseinAdeiza wants to merge 1 commit into
TaceoLabs:mainfrom
HusseinAdeiza:docs/add-developer-faq

Conversation

@HusseinAdeiza
Copy link
Copy Markdown

Summary

Adds comprehensive FAQ documentation for developers working with coCircom and coNoir.

Motivation

Currently there's no centralized FAQ for common developer questions. This leads to:

  • Repeated questions in Discord/GitHub issues
  • Higher support burden on maintainers
  • Slower onboarding for new contributors
  • Scattered information across multiple sources

This FAQ addresses these pain points by consolidating common questions and answers in one place.

What's Included

70+ questions across 7 categories:

1. General Questions

  • What are coSNARKs and why use them?
  • Differences between coCircom and coNoir
  • Production readiness and use cases

2. Installation & Setup

  • System requirements
  • Installation instructions for all platforms
  • Verification steps

3. Usage & Development

  • Converting existing circuits to coSNARKs
  • Working with different MPC protocols
  • Input splitting and multi-party workflows

4. Architecture & Technical

  • MPC witness generation internals
  • Cryptographic assumptions
  • Communication complexity

5. Performance & Optimization

  • Speed optimization strategies
  • Protocol selection guidance (Rep3 vs Shamir)
  • Batched witness extension benefits

6. Troubleshooting

  • Common compilation errors
  • Network connectivity issues
  • Memory problems and solutions

7. Contributing

  • Contribution guidelines overview
  • Testing procedures
  • Code style requirements

File Stats

  • Location: docs/FAQ.md
  • Size: 13KB
  • Lines: 447
  • Questions: 70+

Impact

  • ✅ Reduces support overhead for maintainers
  • ✅ Improves developer onboarding experience
  • ✅ Centralizes scattered documentation
  • ✅ Provides quick reference for common issues

Testing

  • Markdown linting passes
  • Links verified
  • Formatting consistent with project style

This FAQ complements the existing documentation at https://docs.taceo.io and provides quick answers to practical development questions.

Adds FAQ.md covering:
- General questions about coSNARKs
- Installation and setup guide
- Usage and development workflows
- Architecture and technical details
- Performance optimization tips
- Common troubleshooting issues
- Contributing guidelines

70+ questions addressing common developer needs and reducing
support overhead for maintainers.

Signed-off-by: HusseinAdeiza <yunusahusseinadeiza@gmail.com>
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.

1 participant