Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Missing docs #71

Open
8 of 9 tasks
jbmoelker opened this issue Nov 26, 2023 · 1 comment · May be fixed by #215
Open
8 of 9 tasks

Missing docs #71

jbmoelker opened this issue Nov 26, 2023 · 1 comment · May be fixed by #215
Assignees
@jbmoelker
Labels
documentation Improvements or additions to documentation v1 Head Start v1 private
Milestone
v1

Comments

@jbmoelker
Copy link
Member

jbmoelker commented Nov 26, 2023 •
edited
Loading

@jbmoelker jbmoelker added the documentation Improvements or additions to documentation label Nov 26, 2023
@jbmoelker jbmoelker self-assigned this Nov 26, 2023
This was referenced Nov 28, 2023
Merged
Merged
Merged
@jbmoelker
Copy link
Member Author

A more realistic architecture diagram than the one in the main readme:

image

But Mermaid makes it look kinda messy. So need to figure something else out.

This was referenced Dec 2, 2023
Merged
Open
jbmoelker added a commit that referenced this issue Dec 13, 2023
@jbmoelker
docs: CMS content modelling
a5142ce 
Naming conventions with examples. Part of #71.
@jbmoelker jbmoelker mentioned this issue Dec 13, 2023
Merged
4 tasks
@jbmoelker jbmoelker added the v1 Head Start v1 private label Dec 17, 2023
@jbmoelker jbmoelker mentioned this issue Dec 17, 2023
Merged
3 tasks
jbmoelker added a commit that referenced this issue Dec 22, 2023
@jbmoelker
docs: SEO (#75)
2bdc47d 
# Changes

Documents SEO features: CMS features, meta tags, canonical & alternate
links, XML sitemap and robots.txt.

# Associated issue

Part of #71 .

# How to test

Read `docs/seo.md`.

# Checklist

- [x] I have performed a self-review of my own code
- [x] I have made sure that my PR is easy to review (not too big,
includes comments)
- ~~I have added/updated tests to prove that my feature works (if not
possible please explain why)~~
- [x] I have made changes to the README and if the change affects the
project setup (npm commands changed, new service added, environmental
variable added)
- ~~I have added a decision log entry if the change affects the
architecture or changes a significant technology~~
- [x] I have notified a reviewer

<!-- Please strike through and check off all items that do not apply
(rather than removing them) -->
jbmoelker added a commit that referenced this issue Dec 22, 2023
@jbmoelker
docs: CMS data loading (#78)
fb690af 
# Changes

- Document CMS Data Loading configuration and available helper methods,
and GraphQL file usage.

Note: already references methods and files, yet to be merged in #76 and
#68 .

# Associated issue

Part of #71 

# How to test

Review `docs/cms-data-loading.md`

# Checklist

- [x] I have performed a self-review of my own code
- [x] I have made sure that my PR is easy to review (not too big,
includes comments)
- ~~I have added/updated tests to prove that my feature works (if not
possible please explain why)~~
- [x] I have made changes to the README and if the change affects the
project setup (npm commands changed, new service added, environmental
variable added)
- ~~I have added a decision log entry if the change affects the
architecture or changes a significant technology~~
- [x] I have notified a reviewer

<!-- Please strike through and check off all items that do not apply
(rather than removing them) -->
jbmoelker added a commit that referenced this issue Dec 22, 2023
@jbmoelker
docs: Blocks and Components (#79)
5f675fa 
# Changes

- Document Blocks and Components including file structure, templates,
types and use of `<Blocks />`.
- Adds references to new documentation page from main readme and
relevant src directories.

Note: already references files, yet to be merged in #78 .

# Associated issue

Part of #71 

# How to test

Review `docs/blocks-and-components.md`

# Checklist

- [x] I have performed a self-review of my own code
- [x] I have made sure that my PR is easy to review (not too big,
includes comments)
- ~~I have added/updated tests to prove that my feature works (if not
possible please explain why)~~
- [x] I have made changes to the README and if the change affects the
project setup (npm commands changed, new service added, environmental
variable added)
- ~~I have added a decision log entry if the change affects the
architecture or changes a significant technology~~
- [x] I have notified a reviewer
jbmoelker added a commit that referenced this issue Dec 22, 2023
@jbmoelker
docs: CMS content modelling (#88)
8b12794 
Naming conventions with examples. 

# Changes

* Document CMS content modelling best practices and naming conventions.
If reviewer agrees, page models should be renamed to `... Page` and
`bodyBlocks` should be renamed to `blocks`.
* Adds references to new documentation page from main readme. Could add
reference from the blocks readme once #79 is merged.

# Associated issue

Part of #71.

# How to test

Review `docs/cms-content-modelling.md`.

# Checklist

- [x] I have performed a self-review of my own code
- [x] I have made sure that my PR is easy to review (not too big,
includes comments)
- ~~I have added/updated tests to prove that my feature works (if not
possible please explain why)~~
- [x] I have made changes to the README and if the change affects the
project setup (npm commands changed, new service added, environmental
variable added)
- ~~I have added a decision log entry if the change affects the
architecture or changes a significant technology~~
- [x] I have notified a reviewer

<!-- Please strike through and check off all items that do not apply
(rather than removing them) -->
jbmoelker added a commit that referenced this issue Dec 22, 2023
@jbmoelker
docs: Getting Started (#90)
f4ee12e 
# Changes

Adds step-by-step instructions for getting started on a new project
using Head Start.

# Associated issue

Part of #71.

# How to test

Review `docs/getting-started.md` and try out its instructions.

# Checklist

- [x] I have performed a self-review of my own code
- [x] I have made sure that my PR is easy to review (not too big,
includes comments)
- ~~I have added/updated tests to prove that my feature works (if not
possible please explain why)~~
- [z] I have made changes to the README and if the change affects the
project setup (npm commands changed, new service added, environmental
variable added)
- ~~I have added a decision log entry if the change affects the
architecture or changes a significant technology~~
- [x] I have notified a reviewer

<!-- Please strike through and check off all items that do not apply
(rather than removing them) -->
jbmoelker added a commit that referenced this issue Dec 23, 2023
@jbmoelker
feature: DatoCMS collection helper (#76)
33994cb 
# Changes

- Adds a `datocmsCollection` helper function to fetch all records in a
DatoCMS collection.
- Uses pagination so even if a collection has more than 100 records
(DatoCMS query limit) it will still return all records.
- Is flexible enough for different use cases, by accepting a GraphQL
fragment as an argument to use for the given collection.
- Extends `datocmsRequest` with retry on rate limit error.

Simplified example (without types):

```ts
import { datocmsCollection } from '@lib/datocms';

const pages = await datocmsCollection({ 
  collection: 'Pages',
  fragment: `slugs: _allSlugLocales { locale, value }`,
});
```

# Associated issue

Resolves #74 

# How to test

1. Checkout this branch locally
2. Force pagination, by changing `recordsPerPage` to `1` in the new
`datocmsCollection` function in `lib/datocms.ts`
3. Run a local build
4. Verify all the pages are still generated in `dist/[locale]/`
5. Verify all the pages are also still generated in the Cloudflare
deploy preview

# Checklist

- [x] I have performed a self-review of my own code
- [x] I have made sure that my PR is easy to review (not too big,
includes comments)
- ~~I have added/updated tests to prove that my feature works (if not
possible please explain why)~~
- ~~I have made changes to the README and if the change affects the
project setup (npm commands changed, new service added, environmental
variable added)~~ will add this to `docs/data-loading.md` (see #71)
- [x] I have added a decision log entry if the change affects the
architecture or changes a significant technology
- [x] I have notified a reviewer

<!-- Please strike through and check off all items that do not apply
(rather than removing them) -->
@jbmoelker jbmoelker mentioned this issue Dec 25, 2023
Merged
4 tasks
jbmoelker added a commit that referenced this issue Dec 25, 2023
@jbmoelker
docs: Accessibility (a11y) (#99)
1029302 
# Changes

Adds documentation on accessibility (a11y).

# Associated issue

Part of #71 .

# How to test

Review `docs/accessibility.md` and use of `@assets/a11y.css`.

# Checklist

- [x] I have performed a self-review of my own code
- [x] I have made sure that my PR is easy to review (not too big,
includes comments)
- [x] I have made updated relevant documentation files (in project
README, docs/, etc)
- ~~I have added a decision log entry if the change affects the
architecture or changes a significant technology~~
- [x] I have notified a reviewer

<!-- Please strike through and check off all items that do not apply
(rather than removing them) -->
This was referenced Jan 19, 2024
Closed
Merged
@jbmoelker jbmoelker added this to the v1 milestone Jun 29, 2024
@jbmoelker jbmoelker mentioned this issue Nov 9, 2024
Open
jbmoelker added a commit that referenced this issue Nov 11, 2024
@jbmoelker
docs: page partials, client-side scripts, test files
be3e925 
Resolves #71
@jbmoelker jbmoelker linked a pull request Nov 11, 2024 that will close this issue
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jbmoelker jbmoelker

Labels
documentation Improvements or additions to documentation v1 Head Start v1 private
Projects
None yet
Milestone
v1
Development

Successfully merging a pull request may close this issue.

docs: page partials, client-side scripts, test files voorhoede/head-start
1 participant
@jbmoelker