Improve and re-organize documentation#2382
Open
kalinkostashki wants to merge 3 commits intoeclipse-ditto:masterfrom
Open
Improve and re-organize documentation#2382kalinkostashki wants to merge 3 commits intoeclipse-ditto:masterfrom
kalinkostashki wants to merge 3 commits intoeclipse-ditto:masterfrom
Conversation
Contributor
kalinkostashki
commented
Mar 27, 2026
kalinkostashki
commented
- restructured sidebar to be more user friendly and intuitive
- fixed not working links to pages
- added a common writing style for all pages
- added an indexed search via pagefind
… split operatinos
Reorganize the documentation sidebar into a logical 10-section
structure:
Getting Started, Core Concepts, Architecture, Connectivity, APIs &
Interfaces,
WoT Integration, Operating & Extending, Ditto Protocol, Release Notes,
Resources.
- Rewrite sidebar navigation from flat layout to grouped sections with
subfolders
- Move Architecture section before Connectivity for better reading
flow
- Rename "Connecting Devices" to "Connectivity" to reflect backend
integrations
- Promote Connections from Advanced Capabilities to its own Core
Concepts subsection
- Wire 5 new operating sub-pages (Configuration, Authentication,
MongoDB,
Monitoring, DevOps Commands) into the sidebar under Operating &
Extending
- Create real Connectivity overview page replacing redirect stub
- Apply second-person active voice and present tense across all pages
- Add TL;DR callouts summarizing key concepts on each page
- Add code block language tags (json, hocon, text) throughout
- Add "Further reading" sections with cross-reference links
- Restore inline code formatting on technical terms (HTTP methods,
field names,
entity types, permission names, encoding standards)
- Preserve all upstream Ditto 3.9.0 content (encryption migration,
namespace
root policies, fn:format(), WoT Discovery, deprecationNotice)
…n search - Replace search widget in topnav.html with Pagefind UI - Add data-pagefind-body to default layout to scope indexing to content only - Add Pagefind post-build step (npx pagefind) to both Linux and Windows Maven profiles via exec-maven-plugin - Replace old search CSS with Pagefind UI overrides matching Ditto theme - Delete search.json (no longer needed)
- fixed blog posts - fixed open-api docs
kalinkostashki
force-pushed
the
improvement/restructure-docs
branch
from
17c0248 to
f6f37aa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.