silverstripe / silverstripe/developer-docs

Restructure "customise the CMS" docs

Open
#41 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

affects/v4 complexity/medium impact/low type/docs
Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

Description

Overview

The current docs at https://github.com/silverstripe/silverstripe-framework/tree/master/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface are a hodge podge of legacy and new documentation. While some docs are marked as "deprecated", there's no clear learning path for new features.

Acceptance Criteria

  • As a developer customising the CMS, I can follow a clear learning path for React-based CMS sections without getting confused by legacy usage
  • I can get a quick overview of the means to customise the CMS without diving into details
  • I have a path for setting up a SilverStripe CMS module with frontend tooling (either through docs or a bare bones code repository)
  • Legacy documentation is clearly marked on overview and navigational pages
  • Where my customisation my involve multiple approaches (e.g. a reducer and new component), I can easily find relevant sections through cross-linking
  • Legacy docs are stripped to their essentials, with minimal outdated advice (e.g. "we test with JUnit")

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing docs under docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface and compare the legacy and React-based sections against the acceptance criteria. Map the overview, navigation, setup guidance, and cross-links so a developer can follow a clear CMS customisation path, while clearly marking legacy material and removing outdated advice.

Written by the indexing model from the issue text.

Assessment

Tech stack
react
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.