This directory contains comprehensive documentation for the Nodey workflow automation project.
- README.md - Project overview, features, installation, and basic usage
- CONTRIBUTING.md - Development setup, contribution guidelines, and code standards
- typescript-development-guide.md - TypeScript best practices, type safety requirements, and any-type prevention system
- workflow.md - Comprehensive workflow creation, configuration, and execution guide
- CODE_OF_CONDUCT.md - Community guidelines and behavior standards
- SECURITY.md - Security policy and vulnerability reporting
- LICENSE - Project license information
- development-task-log.md - Development task tracking and notes
- CHANGELOG.md - Release notes and version history
- Start with README.md for project overview
- Read CONTRIBUTING.md for development setup
- Review typescript-development-guide.md for coding standards
- Check workflow.md for workflow development patterns
- README.md - Installation and usage instructions
- workflow.md - Complete workflow creation and management guide
- Project features and capabilities
- API documentation (webhooks, workflows)
- CONTRIBUTING.md - Review process and standards
- SECURITY.md - Security procedures
- development-task-log.md - Development tracking
Documentation improvements are welcome! When contributing:
- Keep it concise - Avoid redundancy across files
- Use clear headings - Make content easy to navigate
- Link between docs - Create helpful cross-references
- Update this index - Keep the navigation current
- Follow the established structure - Maintain consistency
- Use Markdown format
- Include code examples where helpful
- Keep language clear and accessible
- Update cross-references when moving content
- Validate all links work correctly
If you can't find what you're looking for:
- Check the README.md for basic information
- Search through CONTRIBUTING.md for development details
- Look at existing code examples in the repository
- Open an issue for documentation improvements