Commit 770c2a1
committed
Add comprehensive documentation for URL namespacing
This commit adds extensive documentation for the URL namespacing system
used throughout the Kolibri codebase, addressing issue #9435.
Changes include:
- New comprehensive how-to guide: "Working with URLs and API Endpoints"
that covers:
* URL naming conventions (kolibri:namespace:resource_endpoint)
* How to define URLs in Django backend (ViewSets, routers, custom URLs)
* How to use URLs in JavaScript frontend (direct access, API Resources)
* Complete explanation of the backend-to-frontend URL pipeline
* Best practices and debugging tips
* Advanced topics (custom endpoints, direct endpoint access)
- Updated existing API endpoints documentation with URL namespacing
overview and cross-reference to the new guide
- Updated frontend core architecture documentation to explain URL
namespacing with practical examples
- Added the new guide to the howtos index
The documentation explains how URL namespacing works implicitly in the
API resource layer and explicitly in frontend code (e.g.,
urls['kolibri:core:driveinfo-list']), providing developers with a
complete understanding of the system.
Fixes #9435
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>1 parent a071b71 commit 770c2a1
File tree
4 files changed
+467
-1
lines changed- docs
- backend_architecture/content
- frontend_architecture
- howtos
4 files changed
+467
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
4 | 24 | | |
5 | 25 | | |
6 | 26 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
82 | | - | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
83 | 105 | | |
84 | 106 | | |
85 | 107 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| 19 | + | |
0 commit comments