✨ Description

The documentation is in dire need of improvements... this is just the beginning.

🔍 Type of change

Select all that apply:

[ ] 🐛 Bug fix (non-breaking change that addresses a specific issue)
[ ] 🚀 New feature (non-breaking change that adds functionality)
[ ] ⚠️ Breaking change (a change that could affect existing functionality)
[ ] 📈 Performance improvement/optimization (improves speed, memory usage, or efficiency)
[ ] 🛠️ Code refactor (non-functional changes that improve code readability, structure, etc.)
[ ] 📦 Dependency bump (updates dependencies, including Dockerfile or package changes)
[x] 📝 Documentation change (updates documentation, including new content or typo fixes)
[ ] 🔧 Infrastructure/Build change (affects build process, CI/CD, or dependencies)

📝 Changes

[x] add docs README.md: https://github.com/ServiceNow/Fast-LLM/tree/tscholak/improve-docs/docs
[x] add new landing page: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/docs/index.md
[x] add single-node quick start guide: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/docs/quick-start.md
[x] add new distributed data preparation script: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/tools/prepare_dataset.py
[x] add cost efficiency comparison: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/docs/cost-efficiency.md
- [ ] measure throughput for the different frameworks
[x] add general help page: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/docs/help.md
[x] add StarCoder 2 success story: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/docs/success-stories/starcoder-2.md
[x] add about us section: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/docs/about-us.md
[x] add join us page: https://github.com/ServiceNow/Fast-LLM/blob/tscholak/improve-docs/docs/join-us.md
[ ] add Fast-LLM in action section:
- [ ] add Slurm guide (dockerized and non-dockerized)
- [ ] add Kubernetes guide (with Kubeflow)
[ ] add real-world examples:
- [ ] add training data preparation
  - [ ] add DCLM preparation
  - [ ] add The Stack preparation
  - [ ] add weighted mix preparation
- [ ] add train Llama 8B from scratch guide
- [ ] add Llama 8B continual pretraining guide
- [ ] add upcycle Llama 3B to MoE guide
[ ] add reference section:
- [ ] add auto-generated configuration option reference.
[ ] add developer's corner:
- [ ] add contributing guidelines
- [ ] add best development practices
  - [ ] describe setting up a dev environment
  - [ ] describe launching test jobs
  - [ ] describe debugging
  - [ ] describe profiling

✅ Checklist

Make sure the following tasks are completed before submitting the PR:

General:

[ ] 📜 I have read and followed the contributing guidelines.
[ ] 🎉 The functionality is complete, and I have tested the changes.
[x] 📝 I have updated the documentation if needed.
[ ] ⚠️ The change does not introduce any new issues (e.g., runtime warnings, type checker errors, linting problems, unhandled edge cases).
[ ] 🧩 I have commented my code, especially in hard-to-understand areas.

Dependencies and Configuration:

[ ] 🐋 I have updated the Docker configuration or dependencies, if applicable.
[ ] 🔄 I have ensured compatibility with the existing setup after dependency changes.

Testing:

[ ] 🧪 I have added or updated tests to cover my changes.
[ ] ✔️ New and existing tests pass locally with my changes.
[ ] 🚦 I have tested these changes on GPUs and verified training stability.
[ ] 🏋️ I have tested the changes on realistic training workloads, if applicable.

Performance Impact:

[ ] 📊 I have run benchmarks where applicable to evaluate the performance impact.
[ ] ✅ The benchmarks show no performance regression.
[ ] 🚀 The benchmarks indicate a potential performance improvement.
[ ] ⚠️ The benchmarks indicate a potential performance degradation.
[ ] 📈 I have provided benchmark results and detailed any performance impact below, if applicable.

📊 Performance Impact Details

If there is any impact on performance, describe it and provide benchmark results, if applicable:

📝 Additional Notes

Include any additional context, information, or considerations here, such as known issues, follow-up tasks, or backward compatibility concerns.

ServiceNow / Fast-LLM

[docs] revamp documentation #17