<h3 dir="auto">Description</h3>
<p dir="auto"><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #6093.">Closes</span> <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="3136409139" data-permission-text="Title is private" data-url="https://github.com/openstreetmap/openstreetmap-website/issues/6093" data-hovercard-type="issue" data-hovercard-url="/openstreetmap/openstreetmap-website/issues/6093/hovercard" href="https://github.com/openstreetmap/openstreetmap-website/issues/6093">#6093</a></p>
<p dir="auto">This PR restructures the core developer documentation (<code class="notranslate">INSTALL.md</code>, <code class="notranslate">CONTRIBUTING.md</code>, and <code class="notranslate">CONFIGURE.md</code>) to improve clarity, navigation, and user experience for new contributors.</p>
<h3 dir="auto"><strong>Key Changes:</strong></h3>
<p dir="auto"><strong>INSTALL.md:</strong></p>
<ul dir="auto">
<li>Prioritized installation methods with Docker/Vagrant prominently featured as recommended options</li>
<li>Reorganized manual installation into clear, numbered steps (Dependencies → Clone → Setup → Validate)</li>
<li>Used collapsible <code class="notranslate"><details></code> sections for platform-specific instructions (Ubuntu, Fedora, macOS) to reduce visual clutter</li>
<li>Added "What's Next?" section linking to CONFIGURE.md and CONTRIBUTING.md</li>
<li>Improved code formatting and visual hierarchy while preserving all technical information</li>
</ul>
<p dir="auto"><strong>CONTRIBUTING.md:</strong></p>
<ul dir="auto">
<li>Added welcoming introduction and table of contents for easy navigation</li>
<li>Created "How to Contribute" workflow overview with step-by-step process ( Find Issue → Fork → Develop → Submit)</li>
<li>Grouped related topics under logical headings:
<ul dir="auto">
<li>"Code Quality Guidelines" (coding style, testing, static analysis, comments)</li>
<li>"Submitting Changes" (committing + pull requests)</li>
</ul>
</li>
<li>Renamed and reorganized sections for better flow (e.g., "Localization (i18n)" for clarity)</li>
</ul>
<p dir="auto"><strong>CONFIGURE.md:</strong></p>
<ul dir="auto">
<li>Reorganized content by task with clear, action-oriented headings</li>
<li>Added table of contents and prerequisites checklist</li>
<li>Converted multi-step processes into numbered lists for clarity</li>
<li>Structured around key tasks: Database Population → User Management → OAuth Setup → Development Tools</li>
<li>Separated development vs. production configuration into distinct sections</li>
<li>Enhanced troubleshooting section with common issues and help resources</li>
</ul>
<p dir="auto"><strong>All changes preserve existing information</strong> while making it more accessible and scannable. The documentation now provides a clear path from installation to contribution, reducing onboarding friction for new developers.</p>
<h3 dir="auto">How has this been tested?</h3>
<ul dir="auto">
<li>Verified all existing links remain functional</li>
<li>Tested collapsible sections render correctly in GitHub markdown</li>
<li>Confirmed table of contents navigation works properly</li>
<li>Validated that all technical instructions and commands are preserved unchanged</li>
<li>Ensured code examples maintain proper syntax highlighting</li>
<li>Reviewed cross-references between documents (INSTALL.md → CONFIGURE.md → CONTRIBUTING.md flow)</li>
</ul>
<hr>
<h4>You can view, comment on, or merge this pull request online at:</h4>
<p> <a href='https://github.com/openstreetmap/openstreetmap-website/pull/6111'>https://github.com/openstreetmap/openstreetmap-website/pull/6111</a></p>
<h4>Commit Summary</h4>
<ul>
<li><a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111/commits/1bd00a21a8fb42134ee922293ba84aaa72e82a1a" class="commit-link">1bd00a2</a> Restructure INSTALL.md</li>
<li><a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111/commits/dc000dd45356489bd1224dd0762b6ae19d26119e" class="commit-link">dc000dd</a> Restructure CONTRIBUTING.md</li>
<li><a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111/commits/f41ffd9bfc5f14aa64ee510f163d565633304891" class="commit-link">f41ffd9</a> Restructure CONFIGURE.md</li>
</ul>
<h4 style="display: inline-block">File Changes </h4> <p style="display: inline-block">(<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111/files">3 files</a>)</p>
<ul>
<li>
<strong>M</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111/files#diff-7b529b3af70da49fbbf1f49523d108b62b1cfe4ee42175a0bbab967b6f11c92e">CONFIGURE.md</a>
(259)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055">CONTRIBUTING.md</a>
(172)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111/files#diff-09b140a43ebfdd8dbec31ce72cafffd15164d2860fd390692a030bcb932b54a0">INSTALL.md</a>
(178)
</li>
</ul>
<h4>Patch Links:</h4>
<ul>
<li><a href='https://github.com/openstreetmap/openstreetmap-website/pull/6111.patch'>https://github.com/openstreetmap/openstreetmap-website/pull/6111.patch</a></li>
<li><a href='https://github.com/openstreetmap/openstreetmap-website/pull/6111.diff'>https://github.com/openstreetmap/openstreetmap-website/pull/6111.diff</a></li>
</ul>
<p style="font-size:small;-webkit-text-size-adjust:none;color:#666;">—<br />Reply to this email directly, <a href="https://github.com/openstreetmap/openstreetmap-website/pull/6111">view it on GitHub</a>, or <a href="https://github.com/notifications/unsubscribe-auth/AAK2OLP4UUAJ74GNAV5U6IL3D3MEVAVCNFSM6AAAAAB7NSSLNCVHI2DSMVQWIX3LMV43ASLTON2WKOZTGE2TAMZVGUZTKNA">unsubscribe</a>.<br />You are receiving this because you are subscribed to this thread.<img src="https://github.com/notifications/beacon/AAK2OLOEZPBDE3HMMGDPAS33D3MEVA5CNFSM6AAAAAB7NSSLNCWGG33NNVSW45C7OR4XAZNFJFZXG5LFVJRW63LNMVXHIX3JMTHLXRU3TI.gif" height="1" width="1" alt="" /><span style="color: transparent; font-size: 0; display: none; visibility: hidden; overflow: hidden; opacity: 0; width: 0; height: 0; max-width: 0; max-height: 0; mso-hide: all">Message ID: <span><openstreetmap/openstreetmap-website/pull/6111</span><span>@</span><span>github</span><span>.</span><span>com></span></span></p>
<script type="application/ld+json">[
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"potentialAction": {
"@type": "ViewAction",
"target": "https://github.com/openstreetmap/openstreetmap-website/pull/6111",
"url": "https://github.com/openstreetmap/openstreetmap-website/pull/6111",
"name": "View Pull Request"
},
"description": "View this Pull Request on GitHub",
"publisher": {
"@type": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
}
]</script>