Skip to content

Commit 5bbec42

Browse files
authored
H/docs styles images (#568)
doc styles + images
1 parent 730fba5 commit 5bbec42

File tree

5 files changed

+114
-57
lines changed

5 files changed

+114
-57
lines changed

components/DocsLayout/DocsLayout.module.scss

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,30 @@
362362
flex: 1;
363363
padding: 1.5rem;
364364
width: 100%;
365+
366+
ul {
367+
margin-top: 0;
368+
margin-bottom: 2rem;
369+
}
370+
371+
li {
372+
font-size: $text-lg;
373+
line-height: 1.3em;
374+
padding-left: 0.5rem;
375+
font-weight: 300;
376+
}
377+
378+
h3 {
379+
font-size: $text-xl;
380+
margin-top: 3rem;
381+
margin-bottom: 1rem;
382+
}
383+
384+
h4 {
385+
font-size: $text-md;
386+
font-weight: 500;
387+
margin-bottom: 1.5rem;
388+
}
365389
}
366390

367391
.contentWrapper {

pages/docs/content/ballots.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ import { getEmbedConfig } from "utils/constants";
66

77
## Serve up geographic ballot information from our database to better inform voters.
88

9+
<img
10+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/ballot.png"
11+
width="600px"
12+
/>
13+
914
Populist Ballot embeds let audiences enter their address to view and research what's on their ballot. It works in conjunction with Candidate Guide and Politician embeds to show URLs of websites that have those content types embedded in them.
1015

1116
export default function DocsPoll({ children }) {

pages/docs/content/candidate-guides.mdx

Lines changed: 80 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ With Populist, organizations can streamline the process of creating candidate gu
1919

2020
When you create a new candidate guide, you are actually creating a new group of candidate guides that all have the same questions. This allows you to create a bulk number of candidate guides with the same questions. We will refer to these groups as candidate guide groups, and the guides for each race in a group as candidate guides.
2121

22+
<img
23+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-add-question.jpg"
24+
width="600px"
25+
/>
26+
2227
### Create Your Questions
2328

2429
Once you create a new candidate guide group, you can add questions that you want to ask candidates, with the following options.
@@ -35,6 +40,11 @@ Once you create a new candidate guide group, you can add questions that you want
3540

3641
- Placeholder text is the copy that is shown in the input field when it is empty - this can be used to give additional context for candidates answering a question.
3742

43+
<img
44+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-add-race.jpg"
45+
width="600px"
46+
/>
47+
3848
### Selecting Races
3949

4050
Next, add the races with the candidates that you want to ask questions to. Each added race creates a new candidate guide for that race. You can search and filter races in an election with the following options.
@@ -57,55 +67,10 @@ Next, add the races with the candidates that you want to ask questions to. Each
5767

5868
If you're asking the same questions to candidates across multiple races, simply add each race to the candidate guide group and they will appear under Races.
5969

60-
### Sending Questions
61-
62-
Once questions and races are added to a candidate guide group, you can export out a spreadsheet of all the candidates in the guide group that includes the following columns:
63-
64-
#### Race Title
65-
66-
- The title of the race that the candidate is running in. The title includes information like the state, office, municipality, race type, and year.
67-
68-
#### First Name
69-
70-
- The first name of the candidate.
71-
72-
#### Middle Name
73-
74-
- The middle name of the candidate.
75-
76-
#### Last Name
77-
78-
- The last name of the candidate.
79-
80-
#### Preferred Name
81-
82-
- The preferred name of the candidate.
83-
84-
#### Suffix
85-
86-
- Any suffix in a candidate's name e.g. Jr, III, Esq.
87-
88-
#### Full Name
89-
90-
- The full name of the candidate that includes the first, middle, last, suffix, and preferred names.
91-
92-
#### Email
93-
94-
- The candidate's email.
95-
96-
#### Form Link
97-
98-
- The URL to the automatically generated form that the candidate can use to submit their responses.
99-
100-
#### Was Candidate Emailed
101-
102-
- Either a true or false value based on the "Email Sent" checkbox that is manually set by users to track whether an email was sent.
103-
104-
#### Last Submission
105-
106-
- The date and time of the last submission by the candidate.
107-
108-
Use this exported spreadsheet with your preferred email list management software to send emails to each of the candidates. Using each column in the spreadsheet, you can personalize the emails to include the candidate's name and the link they will use to respond to the guide questions.
70+
<img
71+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-manage-races.jpg"
72+
width="800px"
73+
/>
10974

11075
### Managing Guides
11176

@@ -133,7 +98,12 @@ Under Races you'll see all the races that have been added to the candidate guide
13398

13499
#### Emails Sent
135100

136-
- A checkbox to help track whether an email was sent to the candidates in a race.
101+
- A checkbox to help you manually track whether an email was sent to the candidates in a race.
102+
103+
<img
104+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-manage-guide.jpg"
105+
width="800px"
106+
/>
137107

138108
By clicking on a row in the Races table, you'll be able to access each race's candidate guide management page. On this page you'll find the following information:
139109

@@ -161,6 +131,66 @@ By clicking on a row in the Races table, you'll be able to access each race's ca
161131

162132
- URLs where the candidate guide has been embedded.
163133

134+
<img
135+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-export.jpg"
136+
width="800px"
137+
/>
138+
139+
### Sending Questions
140+
141+
Once questions and races are added to a candidate guide group, you can export out a spreadsheet of all the candidates in the guide group that includes the following columns:
142+
143+
#### Race Title
144+
145+
- The title of the race that the candidate is running in. The title includes information like the state, office, municipality, race type, and year.
146+
147+
#### First Name
148+
149+
- The first name of the candidate.
150+
151+
#### Middle Name
152+
153+
- The middle name of the candidate.
154+
155+
#### Last Name
156+
157+
- The last name of the candidate.
158+
159+
#### Preferred Name
160+
161+
- The preferred name of the candidate.
162+
163+
#### Suffix
164+
165+
- Any suffix in a candidate's name e.g. Jr, III, Esq.
166+
167+
#### Full Name
168+
169+
- The full name of the candidate that includes the first, middle, last, suffix, and preferred names.
170+
171+
#### Email
172+
173+
- The candidate's email.
174+
175+
#### Form Link
176+
177+
- The URL to the automatically generated form that the candidate can use to submit their responses.
178+
179+
#### Was Candidate Emailed
180+
181+
- Either a true or false value based on the "Email Sent" checkbox that is manually set by users to track whether an email was sent.
182+
183+
#### Last Submission
184+
185+
- The date and time of the last submission by the candidate.
186+
187+
Use this exported spreadsheet with your preferred email list management software to send emails to each of the candidates. Using each column in the spreadsheet, you can personalize the emails to include the candidate's name and the link they will use to respond to the guide questions.
188+
189+
<img
190+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/candidate-guide-submissions.jpg"
191+
width="800px"
192+
/>
193+
164194
### Managing Submissions
165195

166196
You can access each candidate's submissions by clicking on the Submissions tab at the top of the candidate guide management page. To see responses to each question, click on a question and the submissions will populate in the Responses table below. From this table you can add translations, editorial, and manage duplicate submissions for similar guides.

pages/docs/content/legislation.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@ import { BillWidget } from "components/BillWidget/BillWidget";
88

99
Legislation embeds give the latest information about bills as they move through the legislature. They help audiences easily understand what the legislation is about, who is involved, and where the bill is currently in the process of becoming law. Legislation embeds also capture engagement by allowing audiences to vote on whether they support, oppose, or are undecided on a bill.
1010

11-
<BillWidget
12-
embedId={getEmbedConfig()["legislation"].embedId}
13-
billId={getEmbedConfig()["legislation"].billId}
14-
origin={window.location.origin}
15-
renderOptions={{}}
11+
<img
12+
src="https://populist-platform.s3.us-east-2.amazonaws.com/web-assets/images/bill.jpg"
13+
width="600px"
1614
/>
1715

1816
Below are the types of information on each legislation embed:

utils/constants.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ export const EMBED_CONTENT_IDS = {
9090
},
9191
production: {
9292
"candidate-guide": {
93-
embedId: "6db3cbcd-4030-477b-80f1-6496a93d6e4d",
94-
candidateGuideId: "71fafeab-69b0-4c5b-b676-1d479b1ae5fa",
93+
embedId: "b2f081de-dc1a-459e-b78f-da24bab97ca5",
94+
candidateGuideId: "5e9792f9-e811-43d9-85eb-f21d6a08833d",
9595
},
9696
"legislation-tracker": {
9797
embedId: "1234",

0 commit comments

Comments
 (0)