6.0 KiB
6.0 KiB
๐ฆ Documentation Migration Guide
What Changed?
NOFX documentation has been reorganized into a structured docs/ directory for better organization and navigation.
๐บ๏ธ File Locations (Old โ New)
Deployment Guides
DOCKER_DEPLOY.en.mdโdocs/getting-started/docker-deploy.en.mdDOCKER_DEPLOY.mdโdocs/getting-started/docker-deploy.zh-CN.mdCUSTOM_API.mdโdocs/getting-started/custom-api.md
Community Docs
HOW_TO_POST_BOUNTY.mdโdocs/community/bounty-guide.mdINTEGRATION_BOUNTY_HYPERLIQUID.mdโdocs/community/bounty-hyperliquid.mdINTEGRATION_BOUNTY_ASTER.mdโdocs/community/bounty-aster.md
Internationalization
README.zh-CN.mdโdocs/i18n/zh-CN/README.mdREADME.ru.mdโdocs/i18n/ru/README.mdREADME.uk.mdโdocs/i18n/uk/README.mdๅธธ่ง้ฎ้ข.mdโdocs/guides/faq.zh-CN.md
Root Directory (Unchanged)
These stay in the root for GitHub recognition:
README.mdโ (stays in root)LICENSEโ (stays in root)CONTRIBUTING.mdโ (stays in root)CODE_OF_CONDUCT.mdโ (stays in root)SECURITY.mdโ (stays in root)
๐ฏ Why This Change?
Before (โ Problems)
nofx/
โโโ README.md
โโโ README.zh-CN.md
โโโ README.ru.md
โโโ README.uk.md
โโโ DOCKER_DEPLOY.md
โโโ DOCKER_DEPLOY.en.md
โโโ CUSTOM_API.md
โโโ HOW_TO_POST_BOUNTY.md
โโโ INTEGRATION_BOUNTY_HYPERLIQUID.md
โโโ INTEGRATION_BOUNTY_ASTER.md
โโโ ๅธธ่ง้ฎ้ข.md
โโโ ... (15+ markdown files in root!)
Issues:
- ๐ต Too cluttered (15+ files in root)
- ๐ Hard to find specific docs
- ๐ Mixed languages
- ๐ No clear organization
After (โ Benefits)
nofx/
โโโ README.md # Project homepage
โโโ LICENSE # Legal (GitHub needs it here)
โโโ CONTRIBUTING.md # GitHub auto-links
โโโ CODE_OF_CONDUCT.md # GitHub auto-links
โโโ SECURITY.md # GitHub auto-links
โ
โโโ docs/ # ๐ Documentation hub
โโโ README.md # Documentation home
โโโ getting-started/ # ๐ Setup guides
โโโ guides/ # ๐ User guides
โโโ community/ # ๐ฅ Contribution docs
โโโ i18n/ # ๐ Translations
โโโ architecture/ # ๐๏ธ Technical docs
Benefits:
- โ Clean root directory
- โ Logical categorization
- โ Easy navigation
- โ Scalable structure
- โ Professional appearance
๐ New Documentation Structure
Root Level
Files GitHub needs to see:
README.md- Main project pageLICENSE- Open source licenseCONTRIBUTING.md- Contributor guideCODE_OF_CONDUCT.md- Community standardsSECURITY.md- Security policy
docs/ Level
Navigation:
docs/README.md- Start here! Main documentation hub
Categories:
-
getting-started/- Deployment and setup- Docker deployment (EN/ไธญๆ)
- Custom API configuration
-
guides/- Usage guides and tutorials- FAQ (ไธญๆ)
- Troubleshooting (planned)
- Configuration examples (planned)
-
community/- Contribution and bounties- Bounty guide
- Active bounty tasks
- Contributor recognition
-
i18n/- International translationszh-CN/- Simplified Chineseru/- Russianuk/- Ukrainian
-
architecture/- Technical documentation- System design (planned)
- API reference (planned)
- Database schema (planned)
๐ Updating Your Links
If you bookmarked old links:
| Old Link | New Link |
|---|---|
DOCKER_DEPLOY.en.md |
docs/getting-started/docker-deploy.en.md |
README.zh-CN.md |
docs/i18n/zh-CN/README.md |
HOW_TO_POST_BOUNTY.md |
docs/community/bounty-guide.md |
If you linked in your own docs:
Update relative links:
<!-- Old -->
[Docker Deployment](DOCKER_DEPLOY.en.md)
<!-- New -->
[Docker Deployment](docs/getting-started/docker-deploy.en.md)
GitHub URLs automatically redirect!
- Old:
github.com/NoFxAiOS/nofx/blob/main/DOCKER_DEPLOY.en.md - Will redirect to:
github.com/.../docs/getting-started/docker-deploy.en.md
๐ ๏ธ For Contributors
Cloning/Pulling Latest
# Pull latest changes
git pull origin dev
# Your old bookmarks still work!
# Git tracked the file moves (git mv)
Finding Documentation
Use the navigation hub:
- Start at docs/README.md
- Browse by category
- Use the quick navigation section
Or search:
# Find all markdown docs
find docs -name "*.md"
# Search content
grep -r "keyword" docs/
Adding New Documentation
Follow the structure:
# Getting started guides
docs/getting-started/your-guide.md
# User guides
docs/guides/your-tutorial.md
# Community docs
docs/community/your-doc.md
# Translations
docs/i18n/ja/README.md # Japanese example
Update navigation:
- Add link in relevant category README
- Add to
docs/README.mdmain hub
๐ Commit Messages
This reorganization was committed as:
docs: reorganize documentation into structured docs/ directory
- Move deployment guides to docs/getting-started/
- Move community docs to docs/community/
- Move translations to docs/i18n/
- Create navigation hub at docs/README.md
- Update all internal links in README.md
- Add GitHub issue/PR templates
BREAKING CHANGE: Direct links to moved files will need updating
(though GitHub redirects should work)
Closes #XXX
๐ Need Help?
Can't find a document?
- Check docs/README.md navigation hub
- Search GitHub repo
- Ask in Telegram
Link broken?
- Report in GitHub Issues
- We'll fix it ASAP!
Want to contribute docs?
- See Contributing Guide
- Check docs/community/
Migration Date: 2025-11-01 Maintainers: Tinkle Community