Skip to content

[experimental] POC for new v5 Dev Docs structure#1811

Merged
pwizla merged 110 commits intov5/mvpfrom
v5/new-structure
Sep 20, 2023
Merged

[experimental] POC for new v5 Dev Docs structure#1811
pwizla merged 110 commits intov5/mvpfrom
v5/new-structure

Conversation

@pwizla
Copy link
Collaborator

@pwizla pwizla commented Aug 3, 2023

This PR is a POC for the upcoming v5 Dev Docs structure.

Direct preview link 👉 https://documentation-git-v5-new-structure-strapijs.vercel.app/dev-docs/intro#how-to-use-the-strapi-developer-docs

This PR includes:

  • An announcement bar at the top incl. links to the stable docs + a placeholder for an upcoming Google Form
  • Updated custom cards:
    • plus a wrapper to display them as a 2-column grid
    • plus a smaller variant (used for guides)
  • A new TOC structure with 7 main categories
  • A reworked Dev Docs introduction
  • Introduction pages for the new or updated categories
    • Setup & Deployment
      • Installation
      • Configuration
      • Deployment
        • fix secondary introduction pages
          • 3rd-party guides
          • optional guides
    • Content APIs
      • more detailed explanations about the Entity Service and Query Engine APIs
    • Advanced features
    • Customization
    • Plugins
      • general introduction
      • "Using plugins" intro.
      • "Developing plugins" intro.
    • Update & Migration
  • Updated sidebars.js file with:
    • Added link property wherever needed to ensure all breadcrumbs are clickable
    • Added new contextual sidebars for some content-heavy sections, similar to what was introduced for the REST API docs
      • configurations sidebar
      • updates & migrations sidebar (not included in this PR, will come later on)
  • A v5 logo

ℹ️ The PR also removes all v3 → v4 and v4.x to v4.y migration files (hence the many deleted lines).

Additional features and pages may be eventually included.

Mégane Lacheny and others added 30 commits July 19, 2023 15:04
@pwizla pwizla changed the base branch from next to v5/mvp September 19, 2023 14:04
@pwizla
Copy link
Collaborator Author

pwizla commented Sep 20, 2023

Received feedback from Mégane and discussed it with her outside of the GitHub review process. I'm merging the PR with the v5/mvp branch and will backport some changes to v4.

@pwizla pwizla merged commit 90841d1 into v5/mvp Sep 20, 2023
@pwizla pwizla deleted the v5/new-structure branch September 20, 2023 07:40
pwizla added a commit that referenced this pull request Sep 27, 2023
* Add or update components and related CSS

* Backport everything relevant from #1811

* Fix everything that was broken

* Fix everything that was broken

* Fix config. guides order and naming

* Fix links in ProjectStructure.js

* Fix Content APIs → Content API

* Fix TOC for plugins

* Fix Hosting Guides mini-intro.

* Fix TOC

* Highlight new pages in TOC

* Fix prev/next links

* Add various misc. fixes based on Mégane's feedback
@pwizla pwizla added this to the 5.0.0 (stable) milestone Jun 12, 2024
@pwizla pwizla modified the milestones: 5.0.0 (stable), 5.0.0-rc.0 Jun 26, 2024
@pwizla pwizla modified the milestones: 5.0.0-rc.0, 5.0.0 (stable) Aug 13, 2024
@pwizla pwizla added the pr: new content PRs for new product features or new documentation sections label Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team pr: new content PRs for new product features or new documentation sections size: large If the PR includes 1+ file(s) with a total of 50+ lines of text or 100+ lines of code source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo target: next Documentation PRs/issues targeting content from docs-next.strapi.io (next branch)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant