DevDocs

Description

DevDocs is a WordPress plugin for publishing clear, organised developer documentation on your site. It gives you a documentation page with a collapsible sidebar for browsing sections and a main content area for reading articles.

Key Features

  • Documentation articles and updates — Publish help articles and version updates in one place.
  • Organised sections — Group your content into folders and sub-folders for easier browsing.
  • Sidebar navigation — Visitors can move between the overview, sections, articles, and changelog from one menu.
  • Instant search — Quickly find articles from the sidebar as you type.
  • Mobile-friendly layout — The documentation view works cleanly on smaller screens.
  • Welcome screen — Show an introduction, helpful topic cards, and your latest update before a visitor opens an article.
  • Changelog timeline — Display product updates in a clear version-by-version timeline.
  • Custom colours — Match the documentation area to your brand with built-in colour settings.
  • Full-page layout option — Display your documentation in a distraction-free full-browser view.
  • Article guidance — Help readers stay oriented with breadcrumbs, last updated dates, and previous/next article links.
  • Manual ordering — Choose the order in which articles appear inside each section.
  • Translation-ready — Includes English language files and a translation template for other languages.

Usage

Documents

Add your documentation articles in DevDocs and assign them to one or more Topics so they appear in the right place in the sidebar. Use Order if you want to control which articles appear first.

Topics

Use Topics to build your sidebar structure. You can create main sections and place sub-sections inside them, then use Order to control how they are listed.

Changelog

Each changelog entry supports:
* A Version Number and Release Date.
* A summary description.
* Update items grouped as Added, Changed, Fixed, Removed, Deprecated, or Security.

Settings

Navigate to DevDocs Settings to configure:

  • Documentation Page — The WordPress page that renders the docs layout.
  • Documentation Name — Label shown in the sidebar header.
  • Welcome Heading / Message — Text displayed on the overview screen.
  • Show Topic Cards — Toggle topic card grid on the welcome screen.
  • Show Latest Update — Toggle the latest changelog snippet on the welcome screen.
  • Full Page Mode — Expand the documentation into a full-browser layout.
  • Color Scheme — Choose the colours used across the documentation area.

Installation

  1. Upload the devdocs folder to the /wp-content/plugins/ directory, or install via Plugins Add New in the WordPress admin.
  2. Activate the plugin through the Plugins menu.
  3. Create a new WordPress page to serve as your documentation hub (e.g. “Docs”).
  4. Go to DevDocs Settings and select that page under Documentation Page.
  5. Add documents under DevDocs Add Document and organise them with Topics.
  6. Add changelog entries under DevDocs Changelog Add Entry, filling in the Version Info meta box and Changelog Items.

FAQ

How do I add documents to the sidebar?

Create a document under DevDocs Add Document and assign it to a Topic. It will appear in the sidebar automatically.

Can I nest topics?

Yes. You can create main topics and place child topics inside them to build a folder-style structure.

Where is the changelog displayed?

The changelog is available from the Changelog link in the sidebar.

Does DevDocs affect my theme?

DevDocs is designed to keep its layout and styling to your chosen documentation page, so it does not take over the rest of your site.

Is DevDocs translation-ready?

Yes. The plugin includes English language files and a translation template in the languages folder so you can build additional translations.

Reviews

There are no reviews for this plugin.

Contributors & Developers

“DevDocs” is open source software. The following people have contributed to this plugin.

Contributors

Translate “DevDocs” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.0.0

  • Initial release.