Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tmp/
/_site/

# docs src files are copied from metabase via script/seed-docs-history.ts
_docs/
/_docs

# Astro build output
/dist/
Expand Down
4 changes: 1 addition & 3 deletions .stylelintignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ _site/**/*.scss

css/**/*.scss

# TODO: Revisit this once unneeded styles are purged
public/docs/css/gdpr.css
public/docs/css/main.css
# Minified Bootstrap-based bundle inherited from the marketing site.
public/docs/css/styles.css

_lp/v/*
2 changes: 1 addition & 1 deletion .stylelintrc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
},
"overrides": [
{
"files": ["public/css/**/*.css", "_sass/**/*.scss"],
"files": ["public/docs/css/**/*.css"],
"rules": {
"no-descending-specificity": [
true,
Expand Down
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,32 @@ bun dev
```

The dev server runs at http://localhost:4321/docs/latest/.

## Stylesheets

`public/docs/css` holds the stylesheets the docs chrome and content rely on. They
were copied from the marketing site when the remotely fetched shared chrome was
retired (GRO-828) and then pruned to what the rendered docs pages actually use
(GRO-905):

| File | Role |
| ---------------- | ------------------------------------------------------------------------------------------- |
| `styles.css` | Minified Bootstrap 5 subset (scoped under `.bootstrap`) plus the header, footer, `.learn` docs layout, breadcrumb, in-page promo and code-copy styles ported from the marketing bundle. |
| `main.css` | Legacy global styles: typography, links, lists, tables, `.Button`, the old (pre-v0.44) docs layout, image zoom and the feedback widget. Linted by stylelint. |
| `docs.css` | Docs-only overrides for the old docs layout (`.MB-Documentation`, `.container-docs`). |
| `docs-local.css` | Styles that only ever lived in this repo (version selector tags, unsupported-version notice). Loaded last so it can override the files above. |
| `gdpr.css` | Metabase theme for the vendored GDPR cookie notice (`public/docs/gdpr-cookie-notice`). |
| `inkeep.css` | Theme for the Inkeep search/chat widget. |

Sections that remain large on purpose:

- The Bootstrap reboot, grid (`.row`, `.col-*` used by the header) and spacing,
flex, display and typography utilities that the header, footer, breadcrumb,
plans blockquote and feedback widget markup use.
- `.navigation-header` / `#nav-menu-mobile` (desktop mega menu and mobile
drawer) and `.site-footer`.
- `.bootstrap .learn …` rules: the current docs layout, including the
`.copy-code-button`, `.checkpoint__*`, `.table-overflow` and
`.image-wrapper` styles that JavaScript adds after load.
- `.h1`–`.h6` alias selectors: `new-docs-anchor-links.js` adds the heading tag
name as a class to the wrappers it creates.
42 changes: 0 additions & 42 deletions public/docs/css/docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@
text-decoration: underline;
}

.MB-Documentation + .MB-Footer a:hover {
color: #509ee3;
}

.MB-Documentation img {
border: 2px solid #e8e8e8;
border-radius: 2px;
Expand All @@ -39,14 +35,6 @@
cursor: zoom-in;
}

/* Docs header */

.MB-DocumentationHeader {
background-color: #509ee3;
color: #fff;
padding-top: 0;
}

/* Docs hero items */

.MB-Documentation {
Expand Down Expand Up @@ -116,33 +104,3 @@ h3 {
margin-bottom: 32px;
margin-top: 32px;
}

.all-of-the-latest-documentation h1:first-child {
padding: 0;
}

#docs-hero a > * {
color: #509ee3;
}

#docs-hero a:hover > * {
color: #509ee3;
}

#docs-hero a {
padding-bottom: 32px;
}

#docs-hero h3 {
margin-bottom: 8px;
}

#docs-hero h5 {
font-weight: 400;
}

@media screen and (min-width: 60em) {
.MB-Documentation-sm-mr2 {
margin-right: 1.728em;
}
}
6 changes: 0 additions & 6 deletions public/docs/css/gdpr.css
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
/* GDPR Cookie */

body.delay-gdpr-banner .gdpr-cookie-notice {
transition: all ease 1s 10s;
}

.gdpr-cookie-notice {
background: #22242b;
border-radius: 0.75rem;
Expand Down
Loading
Loading