Godux Logo

gudox

Documentation

Learn how to use GoodDocs - a collaborative document editing platform with advanced version control and AI-powered features.

What is GoodDocs?

GoodDocs is a collaborative document editing platform that combines the power of Git-style version control with AI-enhanced writing tools. It allows teams to work together on documents while maintaining full history, branching capabilities, and automated content improvements.

Core Concepts

Workspaces

Workspaces are collaborative environments where teams can work on documents together. Each workspace has a unique code for easy sharing and contains multiple branches for different versions of content.

Branches

Branches allow you to work on different versions of your document simultaneously. Create feature branches for new content, experiment with changes, or work on different sections independently.

Commits

Commits save snapshots of your work with descriptive messages. They create a permanent history of changes and allow you to revert to previous versions when needed.

Merge Requests

Merge requests propose changes from one branch to another. They include automated content analysis and provide a collaborative review process before integrating changes.

Getting Started

1. Create or Join a Workspace

Create New: Start a new workspace from the dashboard by providing a name and description.

Join Existing: Use a workspace code to join an existing collaborative workspace.

đź’ˇ Tip: Workspace codes make sharing easy!
2. Understanding the Interface

Branch Selector: Switch between different document versions

Document Area: Rich text editor with real-time auto-save

AI Tools: Proofread, rewrite, and generate content

Version Controls: Commit, merge, and history management

Document Editing Features

Real-time Editing
  • • Auto-save every few seconds
  • • Rich text formatting
  • • Visual diff highlighting
  • • Undo/redo support
AI-Powered Tools
  • • Proofread for grammar/style
  • • Rewrite for clarity
  • • Generate new content
  • • Smart suggestions
Change Tracking
  • • Visual change indicators
  • • Commit when ready
  • • Revert to any version
  • • Compare versions

Version Control Workflow

1. Create a Branch

Start working on a new feature or section by creating a branch. This keeps your changes isolated until they're ready.

2. Edit & Save

Make your changes in the document editor. Content is auto-saved, and you'll see visual indicators of what's changed.

3. Commit Changes

When satisfied with your changes, commit them with a descriptive message. This creates a permanent snapshot in the version history.

4. Create Merge Request

Propose your changes by creating a merge request. This triggers automated content analysis and allows team review.

Merge Requests & Automation

Merge Request Process

Create: Submit changes with title and description

Review: Team members can review and comment

Automate: AI analyzes content automatically

Accept: Merge approved changes into target branch

Automation Features

Proofreading: Automatic grammar and style checking

Summarization: AI-generated content summaries

Custom Automations: Configure per-branch automation rules

Powered by AI

History & Navigation

Branch History

  • • View all commits for a branch
  • • See detailed change descriptions
  • • Revert to any previous commit
  • • Compare different versions

Merge History

  • • Track all merge requests
  • • View automation results
  • • Revert to previous merges
  • • Understand change evolution

Best Practices

Collaboration Tips

Use Descriptive Branch Names: Name branches after features or sections (e.g., “chapter-3-revision”, “marketing-copy”)

Commit Often: Make frequent commits with clear messages to track your progress and facilitate collaboration

Review Before Merging: Use merge requests to ensure quality and get team input on changes

Leverage AI Tools: Use proofreading and rewriting features to improve content quality before committing

Workflow Organization

Main Branch: Keep the main branch stable and polished

Feature Branches: Create separate branches for different features, chapters, or experimental content

Regular Merging: Merge completed features back to main regularly to avoid conflicts

Automation Setup: Configure branch automations to maintain content quality automatically

Technical Features

Platform
  • • Built with Next.js & React
  • • Firebase backend
  • • Real-time synchronization
  • • Responsive design
AI Integration
  • • Chrome AI (Gemini Nano)
  • • Local processing
  • • Privacy-focused
  • • Offline capabilities
Security
  • • User authentication
  • • Workspace access control
  • • Data encryption
  • • Secure collaboration