Scrub a few remaining uses of 'ATIP' in docs. #536

README.md

@@ -1,20 +1,13 @@
-# Active Travel Infrastructure Platform
+# Plan Your Active Travel Schemes
 
-ATIP lets you design, modify and share active travel infrastructure plans.
+This repository contains the Scheme Sketcher and Scheme Browser, two tools for mapping active travel schemes and viewing them alongside contextual layers. The tools re developed by the Alan Turing Institute in collaboration with Active Travel England.
 
-It's developed by the Alan Turing Institute in collaboration with Active Travel England.
+## Usage
 
-## Using ATIP
+The development version is available for use at <https://acteng.github.io/atip>. Note this is not a production service and we make no guarantees about the site's uptime or about backwards compatibility of sketch files.
 
-The development version of ATIP with data for England is available for use at <https://acteng.github.io/atip>.
-Note: this is not a production service and we make no guarantees about the site's uptime or about backwards compatibility of ATIP files.
+See the [developer guide](docs/developer_guide.md) if you want to work on the code.
 
-## Development
+### Usage in other places
 
-See our current roadmap on the [Milestones](https://github.com/acteng/atip/milestones?direction=desc&sort=completeness&state=open) page. Issues, feature requests, and pull requests are welcome. Please open an issue if you're interested in contributing!
-
-See the [developer guide](docs/developer_guide.md) if you want to work on ATIP.
-
-### Using ATIP in other places
-
-You can set up the scheme sketcher in another place, using [the common library](https://github.com/acteng/scheme-sketcher-lib). You'll need technical experience to do this. Please [file an issue](https://github.com/acteng/atip/issues/new) to start a conversation.
+You can set up the Scheme Sketcher for another country, using [the common library](https://github.com/acteng/scheme-sketcher-lib). You'll need technical experience to do this. Please [file an issue](https://github.com/acteng/atip/issues/new) to start a conversation.

docs/data_spec.md

@@ -1,5 +1,7 @@
 # ATIP GeoJSON specification
 
+NOTE: This document is out-of-date as of November 2024. If you're relying on this file format, please file a Github issue.
+
 This document describes the file format that ATIP creates and exports. It's helpful if you're writing software that consumes these files, or if you're trying to create one using other GIS software. Files produced by ATIP can be used with any GIS software handling GeoJSON files. If you're trying to load a GeoJSON file in ATIP, it won't work unless it fits the format described here.
 
 ## Specification

docs/developer_guide.md

@@ -2,27 +2,25 @@
 
 ## Code overview
 
-This repository contains the Svelte ATIP app. Our tech stack is:
+This repository contains the Svelte app. Our tech stack is:
 
 - [Vite](https://vitejs.dev) as the build tool
 - [Svelte](https://svelte.dev) as the UI framework
 - [MapLibre GL](https://maplibre.org) as the map
 - [GOV.UK frontend](https://frontend.design-system.service.gov.uk) for styling
 
-There are some related repositorites also part of ATIP:
-
-- [atip-data-prep](https://github.com/acteng/atip-data-prep) is a set of scripts to generate data files that ATIP loads
-- [route-snapper](https://github.com/dabreegster/route_snapper/) is a tool to draw routes snapped to existing roads
-- [osm2streets](https://github.com/a-b-street/osm2streets) is a library to process and query OpenStreetMap data
+There are some related repositorites:
 
+- [atip-data-prep](https://github.com/acteng/atip-data-prep) is a set of scripts to generate data files that the Scheme Browser loads
+- [route-snapper](https://github.com/dabreegster/route_snapper/) is a tool to draw routes and areas snapped to existing roads
 
 ### Contributions to this doc
 
 We have only included instructions or guidance for environments we've worked on: if it doesn't work for you or your environment, please make a pull request so others don't face the same pain you did!
 
 ### Background reading
 
-These are some resources to learn languages and libraries used in ATIP. Feel free to add more!
+These are some resources to learn languages and libraries used in this repo. Feel free to add more!
 
 - TypeScript
   - [Docs based on your background](https://www.typescriptlang.org/docs/)
@@ -46,7 +44,7 @@ To run locally you'll need [npm](https://docs.npmjs.com/downloading-and-installi
 
 - `npm install` to install dependencies
 - `npm run setup-govuk` to rerun Sass and generate GOV.UK styles
-- `npm run dev` to run ATIP locally (N.B. you need to run all the above commands before running this command)
+- `npm run dev` to run locally (N.B. you need to run all the above commands before running this command)
   - To mimic GCP deployment and see private layers locally, follow instructions in `.env` and run `VITE_RESOURCE_BASE="" VITE_MIMIC_GCP_LOCALLY="true" npm run dev`
 - `npm run fmt` to auto-format code
 - `npm run check` to see TypeScript errors
@@ -71,7 +69,7 @@ Once you've installed these you can:
 2. Press F1 to open input command at top of window
 3. Run `Dev Containers: Open Folder in Container`, and select the `atip` folder
 4. Press the plus on the top right of the terminal subwindow at the bottom of VSCode (by default) to open a terminal in your docker container
-5. Run `npm install`, `npm run dev`, and then you should have ATIP running on your docker image. VS Code should prompt you with a link to open it in your browser.
+5. Run `npm install`, `npm run dev`, and then you should have the web app running on your docker image. VS Code should prompt you with a link to open it in your browser.
 
 ### Monkey-patching dependencies