Skip to content

Changing or Adding Site Copy

Anne LoVerso edited this page Apr 27, 2021 · 5 revisions

All of the editable site copy lives in this directory.

It contains the following:

contextual-information is the content for contextual info panels. See the detailed guide on how to use these in particular

Other folders such as roadmap and onboarding and so on contain files for the copy for these pages. There are two types of file, .md and .ts.

There are also .ts files at the top-level for copy that is not page-specific.

Onboarding - copy changes

Each file is a .md Markdown file using Markdown syntax

At the top, they should have a "gray matter" metadata section with three dashes indicating its start and end. We have one optional metadata property for onboarding pages, which is the placeholder text for the input element. If there is no need for the element to have placeholder text (like a Select element), then this can be left blank (and any value would be ignored).

Example with gray matter:

---
placeholder: "Type a name"
---

### Business Name

What do you want to name your business? You can change this name again later.

Example without gray matter (note empty gray-matter section indicated by --- lines)

---
---

### Industry

Which business industry can best describe your company?

Roadmap - copy changes

This is markdown (so it can have contextual info added, bold, links, etc) but content written here will be displayed in the larger subheader size that is currently on the roadmap page.

.ts files - copy changes

Don't change the structure of these files, but feel free to change anything in the right-hand value side of the "key": "value" pairs:

export const LegalStructureLookup: Record<LegalStructure, string> = {
  "sole-proprietorship": "CHANGE ME TO ANYTHING",
  ...

We have these files for individual pages as well as more general use-cases like the display text for completion tags.

NOTE: using template values

Some of the values are "template values" which means they include variable text. For example, in the OnboardingDefaults:

stepXofYTemplate: "Step ${currentPage} of ${totalPages}",

You are welcome to change this value, however, do not change the name/format of the values in ${this notation}. Those are for the code so that it knows how to insert those values so that the step label changes.

So you can rearrange if you want (like so), but do not change the ${} bits:

stepXofYTemplate: "Out of ${totalPages} steps, you are on Step ${currentPage}",

Running velocity:

sprint 4: 11

sprint 5: 9

sprint 6: 7

sprint 7: 12

sprint 8: 9

sprint 8: 12

3-week average: 11

Clone this wiki locally