If you discover a security vulnerability in this project, please report it by:
- DO NOT open a public issue
- Email the maintainer directly (check the repository for contact information)
- Include:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if any)
We will respond as quickly as possible and work with you to address the issue.
- Never commit sensitive files: Ensure your
docs/folder doesn't contain:- API keys, tokens, or credentials
- Personal identifiable information (PII)
- Proprietary or confidential information
- Private keys or certificates
- Always review the script before running it on your documentation
- Check what files will be processed: the script scans all
.mdfiles indocs/subdirectories - Verify the output in
doc_exports/before sharing
- Use a virtual environment for running this script
- Keep your Python installation and dependencies up to date
- Review the code if you're processing sensitive documentation
- The
doc_exports/directory is gitignored by default - Verify your
.gitignoreis working before committing - Review consolidated files before uploading them anywhere
- Be aware that consolidating documents may expose information you intended to keep separate
If sharing exported documentation publicly:
- Remove any internal references, URLs, or system paths
- Sanitize examples that might contain real data
- Review for accidentally included credentials or secrets
- Consider if the consolidated view reveals information architecture you want to keep private
- This script does not encrypt or redact any content
- It processes files as plain text without security scanning
- It's the user's responsibility to ensure source documentation is safe to consolidate and share
This is a simple utility script. Always use the latest version from the main branch.
Security-related updates will be noted in release notes and commit messages with a [SECURITY] prefix.