Merge pull request #14208 from guardian/ravi/update-readmes

Revamp READMEs

Author: arelra

README.md

@@ -1,33 +1,11 @@
-# Dotcom/Apps Rendering
+# Dotcom Rendering & Apps Rendering
 
-This repository contains the rendering logic for articles on theguardian.com. It is a monorepo with 2 projects, `apps-rendering` and `dotcom-rendering`.
+This repository contains the rendering logic for theguardian.com and for a subset of articles in the live apps.
 
-## Developer setup
-
-Install [Node.js](https://nodejs.org).
-
-We recommend using [fnm](https://github.com/Schniz/fnm). It is great at managing multiple versions of Node.js on one machine.
-
-> You may find it useful to add `--version-file-strategy recursive` to the [`fnm` shell setup](https://github.com/Schniz/fnm?tab=readme-ov-file#shell-setup). This will set the active Node version to first version it finds in the current directory _or_ any parent directory.
-
-Once Node is installed, make sure you're using the correct package manager by [enabling corepack](https://github.com/nodejs/corepack?tab=readme-ov-file#utility-commands):
-
-```sh
-corepack enable
-```
-
-> [!NOTE]
->
-> If you're using `asdf`, you'll need to run `asdf reshim nodejs` after running `corepack enable`.
-
-## Install
-
-Run `pnpm install` in the root directory of this project to install packages.
+It is a monorepo with 2 projects, `apps-rendering` and `dotcom-rendering`.
 
 ## Run
 
-You should always `cd` into the correct subdirectory before running commands (e.g `make dev` for dotcom-rendering, or `pnpm watch` for apps-rendering) except for storybook.
-
 ### `apps rendering`
 
 Go to [apps rendering](apps-rendering/README.md) for more details.
@@ -38,15 +16,9 @@ Go to [dotcom rendering](dotcom-rendering/README.md) for more details.
 
 ## Root actions
 
-Most commands are run from within each project but the following are managed from the monorepo root:
+Most commands are run from within each project but the following can be run from the root:
 
-### Storybook/Chromatic
+### Storybook
 
 `pnpm storybook` - Runs Storybook for all projects
 `pnpm build-storybook` - Builds Storybook for all projects
-
-Chromatic now runs at project level. `cd` into the project dir and run `pnpm chromatic -t [CHROMATIC PROJECT TOKEN]`
-
-You can find the token in the project Chromatic instance.
-
-To run Chromatic in CI on your pr, add the `run_chromatic` label once you're ready to check for visual regressions.