[openstreetmap/openstreetmap-website] Restructure core developer docs (PR #6111)
Emin Kocan
notifications at github.com
Mon Jun 16 15:03:38 UTC 2025
### Description
Closes #6093
This PR restructures the core developer documentation (`INSTALL.md`, `CONTRIBUTING.md`, and `CONFIGURE.md`) to improve clarity, navigation, and user experience for new contributors.
### **Key Changes:**
**INSTALL.md:**
- Prioritized installation methods with Docker/Vagrant prominently featured as recommended options
- Reorganized manual installation into clear, numbered steps (Dependencies → Clone → Setup → Validate)
- Used collapsible `<details>` sections for platform-specific instructions (Ubuntu, Fedora, macOS) to reduce visual clutter
- Added "What's Next?" section linking to CONFIGURE.md and CONTRIBUTING.md
- Improved code formatting and visual hierarchy while preserving all technical information
**CONTRIBUTING.md:**
- Added welcoming introduction and table of contents for easy navigation
- Created "How to Contribute" workflow overview with step-by-step process ( Find Issue → Fork → Develop → Submit)
- Grouped related topics under logical headings:
- "Code Quality Guidelines" (coding style, testing, static analysis, comments)
- "Submitting Changes" (committing + pull requests)
- Renamed and reorganized sections for better flow (e.g., "Localization (i18n)" for clarity)
**CONFIGURE.md:**
- Reorganized content by task with clear, action-oriented headings
- Added table of contents and prerequisites checklist
- Converted multi-step processes into numbered lists for clarity
- Structured around key tasks: Database Population → User Management → OAuth Setup → Development Tools
- Separated development vs. production configuration into distinct sections
- Enhanced troubleshooting section with common issues and help resources
**All changes preserve existing information** while making it more accessible and scannable. The documentation now provides a clear path from installation to contribution, reducing onboarding friction for new developers.
### How has this been tested?
- Verified all existing links remain functional
- Tested collapsible sections render correctly in GitHub markdown
- Confirmed table of contents navigation works properly
- Validated that all technical instructions and commands are preserved unchanged
- Ensured code examples maintain proper syntax highlighting
- Reviewed cross-references between documents (INSTALL.md → CONFIGURE.md → CONTRIBUTING.md flow)
You can view, comment on, or merge this pull request online at:
https://github.com/openstreetmap/openstreetmap-website/pull/6111
-- Commit Summary --
* Restructure INSTALL.md
* Restructure CONTRIBUTING.md
* Restructure CONFIGURE.md
-- File Changes --
M CONFIGURE.md (259)
M CONTRIBUTING.md (172)
M INSTALL.md (178)
-- Patch Links --
https://github.com/openstreetmap/openstreetmap-website/pull/6111.patch
https://github.com/openstreetmap/openstreetmap-website/pull/6111.diff
--
Reply to this email directly or view it on GitHub:
https://github.com/openstreetmap/openstreetmap-website/pull/6111
You are receiving this because you are subscribed to this thread.
Message ID: <openstreetmap/openstreetmap-website/pull/6111 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20250616/75ad4a96/attachment-0001.htm>
More information about the rails-dev
mailing list