Skip to main content

Contributing to AddPath Documentation

This guide provides detailed instructions for editing the AddPath documentation through GitHub.

Quick Start for Editors​

1. Understanding the Structure​

docs/
├── AddPath User Guide.md          # Main navigation hub (you are here)
├── documentation/                 # Core technical documentation
│   ├── setup-configuration/      # Robot and system setup
│   ├── programming/               # Manufacturing workflows
│   ├── simulation-analysis/      # Testing and validation
│   └── mold-management/           # Tooling management
├── getting-started/               # Installation and licensing
├── program-generation/            # Code export features
├── reference/                     # Troubleshooting and glossary
└── support/                       # Help and training

2. File Naming Conventions​

  • Use lowercase with hyphens: robot-configuration.md
  • Be descriptive: tcp-configuration-guide.md
  • Avoid spaces and special characters
  • Match folder names to content topics
# Internal links (to other docs)
[Link Text](./folder/filename.md) - Brief description

# External links
[AddComposites Website](https://addcomposites.com)

# Section links within same document
[Go to Setup](#setup-section)

Editing Guidelines​

Markdown Best Practices​

  1. Headers: Use # for main titles, ## for sections, ### for subsections
  2. Bold text: Use **text** for UI elements and important terms
  3. Code blocks: Use triple backticks with language specification
  4. Lists: Use - for bullets, 1. for numbered lists
  5. Images: Store in /static/img/addpath-guide/ and reference as ![Alt text](/img/addpath-guide/filename.png)

Content Structure​

Each documentation page should include:

  • Clear title and brief description
  • Table of contents for longer pages
  • Step-by-step instructions where applicable
  • Screenshots or diagrams when helpful
  • Links to related topics
  • Last updated information

When adding new pages:

  1. Create the markdown file in the appropriate folder
  2. Add entry to the parent folder's _category_.json if needed
  3. Update the main "AddPath User Guide.md" with link
  4. Test navigation flow from the main guide

GitHub Workflow​

Making Changes​

  1. Fork the repository (if external contributor)
  2. Create a feature branch: git checkout -b update-documentation
  3. Make your changes following the guidelines above
  4. Test locally if possible (see Testing section)
  5. Commit with descriptive message: git commit -m "Update robot setup guide with new TCP instructions"
  6. Push and create pull request

Commit Message Format​

Use clear, descriptive commit messages:

Add new laminate configuration examples
Fix broken links in simulation overview
Update installation requirements for Windows
Reorganize troubleshooting section

Review Process​

  • All changes require review before merging
  • Structural changes need development team approval
  • Test builds automatically run on pull requests
  • Reviewers check for link accuracy and content quality

Testing Your Changes​

Local Testing (Optional)​

If you have Node.js installed:

npm install
npm run start

This starts a local development server to preview changes.

Before submitting:

  1. Check all new links work correctly
  2. Verify internal navigation flows logically
  3. Ensure images display properly
  4. Test responsive design on mobile

Build Verification​

  • GitHub Actions automatically test builds
  • Check the "Actions" tab for build status
  • Fix any build errors before requesting review

Content Guidelines​

Writing Style​

  • Clear and concise: Use simple, direct language
  • User-focused: Write for end users, not developers
  • Consistent terminology: Use the same terms throughout
  • Action-oriented: Start instructions with action verbs

Screenshots and Images​

  • Use high-quality screenshots at standard resolutions
  • Highlight relevant UI elements with arrows or boxes
  • Store images in /static/img/addpath-guide/
  • Use descriptive filenames: robot-configuration-tcp-setup.png
  • Include alt text for accessibility

Code Examples​

# Use code blocks for commands
```bash
npm install

Use inline code for UI elements

Click the Configure button, then select Robot Settings.


## Common Issues and Solutions

### Broken Links
- Always use relative paths for internal links
- Test links after moving or renaming files
- Use the search function to find references to moved content

### Build Failures
- Check for unclosed markdown elements
- Verify image paths are correct
- Ensure no special characters in filenames

### Missing Images
- Images must be in `/static/img/` directory
- Use forward slashes in image paths
- Check image file extensions match references

## Getting Help

### Resources
- **Docusaurus Documentation**: https://docusaurus.io/docs
- **Markdown Guide**: https://www.markdownguide.org/
- **Project Issues**: Use GitHub Issues for questions

### Contact
- **Development Team**: For structural changes or technical issues
- **Content Questions**: Open a GitHub issue with "documentation" label
- **Urgent Issues**: Contact project maintainers directly

---

**Last Updated**: August 20, 2025  
**Version**: 1.0  
**Next Review**: Check quarterly for updates