=== DevDocs ===
Contributors: alexhedstrom
Tags: documentation, docs, changelog, knowledge base, developer
Requires at least: 6.3
Tested up to: 7.0
Requires PHP: 7.4
Stable tag: 1.0.5
License: GPL-2.0+
License URI: http://www.gnu.org/licenses/gpl-2.0.txt

Developer software documentation with folder-based navigation, changelog tracking, and customizable color schemes.

== 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.
* **Shortcode support** — Embed documentation with `[devdocs]` as an alternative to selecting a page.
* **Translation-ready** — Includes a translation template in the `languages` folder for other languages.

== 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. Display the docs in one of two ways:
   * Create a page (e.g. "Docs"), then go to **DevDocs → Settings** and select it under **Documentation Page**, or
   * Add the `[devdocs]` shortcode to any page or post.
4. Add documents under **DevDocs → Add Document** and organise them with Topics.
5. Add changelog entries under **DevDocs → Changelog → Add Entry**, filling in the Version Info meta box and Changelog Items.

== 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** — Optional WordPress page that renders the docs layout automatically. You can use the `[devdocs]` shortcode instead.
* **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 (applies to the selected Documentation Page).
* **Color Scheme** — Choose the colours used across the documentation area.

= Shortcode =
Add `[devdocs]` to any page or post content to embed the documentation layout. Navigation links stay on that page. You do not need to select a Documentation Page in settings when using the shortcode.

In page builders such as Breakdance, use the dedicated **Shortcode** element (not only a rich text field). The builder canvas may need a refresh after saving; the front end is the source of truth if preview still looks incomplete.

== Frequently Asked Questions ==

= 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.

= How do I display the documentation? =
Either select a **Documentation Page** in **DevDocs → Settings**, or place the `[devdocs]` shortcode on any page or post.

= 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 or shortcode placement, so it does not take over the rest of your site.

= Is DevDocs translation-ready? =
Yes. The plugin includes a translation template (`devdocs.pot`) in the `languages` folder so you can build additional translations.

== Screenshots ==

1. Documentation layout with sidebar navigation and content area.
2. Welcome screen with topic cards and latest changelog snippet.
3. Changelog timeline view.
4. Settings page with color scheme pickers.
5. Changelog entry editor with version info and change-type items.

== Changelog ==

= 1.0.5 =
* Respect password-protected documentation pages.
* Fix sidebar folders clipping long document lists.
* Sort changelog entries by release date.
* Accessibility improvements for search and mobile menu.
* Tighten settings, uninstall, and asset loading.

= 1.0.4 =
* Improve [devdocs] shortcode preview in page builders such as Breakdance.

= 1.0.3 =
* Add [devdocs] shortcode as an alternative to selecting a documentation page.

= 1.0.2 =
* Make the sidebar match the full height of the documentation content.

= 1.0.1 =
* Fix search field and icons not showing in full page mode.
* Let documentation pages grow with content instead of a fixed viewport height.
* Sort Topics by Order in the admin list table.

= 1.0.0 =
* Initial release.
