Skip to content

Commit 0c6254a

Browse files
committed
chore(content): match README and homepage
1 parent f97400e commit 0c6254a

File tree

2 files changed

+7
-11
lines changed

2 files changed

+7
-11
lines changed

Diff for: README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,13 @@ Published online at <https://docs.calitp.org>
44

55
## What is this repository for?
66

7-
This is a GitHub Pages *organization site*, created in a repository named with the pattern `org-name.github.io`.
8-
For Cal-ITP, that is [`cal-itp.github.io`](https://github.com/cal-itp/cal-itp.github.io).
7+
This is Cal-ITP's [GitHub Pages organization repository](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites), served under a custom domain using a
8+
[CNAME](https://github.com/cal-itp/cal-itp.github.io/blob/main/CNAME) file.
99

10-
Like all GitHub Pages sites, organization sites can define a
11-
[`CNAME`](https://github.com/cal-itp/cal-itp.github.io/blob/main/CNAME) file to customize the domain.
10+
This site is the root of Cal-ITP's GitHub Pages project sites - the repositories that have GitHub Pages enabled.
11+
These sites are automatically available at `https://docs.calitp.org/repo-name`.
1212

13-
An organization site serves as the root of that organization's *project sites*, which are just the other repositories within
14-
the organization that have GitHub Pages enabled.
15-
16-
With the custom domain configured here, all Cal-ITP GitHub Pages sites are automatically available at
17-
**https://docs.calitp.org/repo-name**.
13+
To create a simple Markdown-based documentation site, see our instructions at <https://docs.calitp.org/mkdocs-template>.
1814

1915
## Local development
2016

Diff for: _includes/about.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ <h2>What is this site?</h2>
77
<a href="https://github.com/cal-itp/cal-itp.github.io/blob/main/CNAME">CNAME</a> file.
88
</p>
99
<p>
10-
This site is the root of Cal-ITP's GitHub Pages project sites, which are the other repositories that have GitHub Pages enabled. These
11-
sites are automatically available at <code>https://docs.calitp.org/repo-name</code>.
10+
This site is the root of Cal-ITP's GitHub Pages project sites - the repositories that have GitHub Pages enabled.
11+
These sites are automatically available at <code>https://docs.calitp.org/repo-name</code>.
1212
</p>
1313
<p>
1414
To create a simple Markdown-based documentation site, see our instructions at:

0 commit comments

Comments
 (0)