From 114fb7f0f1e2d1ed4b8600a87862bfb76894d456 Mon Sep 17 00:00:00 2001 From: R I B Z Date: Wed, 31 Jan 2024 09:46:19 -0800 Subject: [PATCH 1/4] Adds docs page with no content besides header --- src/docs/index.html | 22 ++++++++++++++++++++++ src/templates/cap-docs-page.js | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 src/docs/index.html create mode 100644 src/templates/cap-docs-page.js diff --git a/src/docs/index.html b/src/docs/index.html new file mode 100644 index 0000000..7231393 --- /dev/null +++ b/src/docs/index.html @@ -0,0 +1,22 @@ + + + + Documentation | Caselaw Access Project + + + + + + + + + + + + + + + + + + diff --git a/src/templates/cap-docs-page.js b/src/templates/cap-docs-page.js new file mode 100644 index 0000000..2a39af4 --- /dev/null +++ b/src/templates/cap-docs-page.js @@ -0,0 +1,34 @@ +import { LitElement, html } from "../lib/lit.js"; +import "../components/cap-nav.js"; +import "../components/cap-page-header.js"; +import "../components/cap-footer.js"; +import "../components/cap-anchor-list.js"; +import "../components/cap-media-list.js"; +import "../components/cap-contributor-list.js"; + +export class CapDocsPage extends LitElement { + // Turn Shadow DOM off + // Generally discouraged: https://lit.dev/docs/components/shadow-dom/#implementing-createrenderroot + createRenderRoot() { + return this; + } + + render() { + return html` + +
+
+ +

+ Welcome to the Caselaw Access Project Documentation. + Here you'll find some documentation about our project, + organization, data, applications, services, and site. +

+ +
+
+ + `; + } +} +customElements.define("cap-docs-page", CapDocsPage); From 95a02dd4191a82f90e6ba7a86330295a85b8a857 Mon Sep 17 00:00:00 2001 From: R I B Z Date: Wed, 31 Jan 2024 10:22:17 -0800 Subject: [PATCH 2/4] adds placeholder content for documentation --- src/data/docsSidebarLinks.js | 10 ++++++++++ src/templates/cap-docs-page.js | 20 ++++++++++++++++++-- 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 src/data/docsSidebarLinks.js diff --git a/src/data/docsSidebarLinks.js b/src/data/docsSidebarLinks.js new file mode 100644 index 0000000..491b87d --- /dev/null +++ b/src/data/docsSidebarLinks.js @@ -0,0 +1,10 @@ +export const anchorLinks = [ + { + title: "Accessing Data", + url: "#accessing-data", + }, + { + title: "Bulk Downloads", + url: "#bulk-downloads", + }, +] \ No newline at end of file diff --git a/src/templates/cap-docs-page.js b/src/templates/cap-docs-page.js index 2a39af4..e5ae32f 100644 --- a/src/templates/cap-docs-page.js +++ b/src/templates/cap-docs-page.js @@ -3,8 +3,7 @@ import "../components/cap-nav.js"; import "../components/cap-page-header.js"; import "../components/cap-footer.js"; import "../components/cap-anchor-list.js"; -import "../components/cap-media-list.js"; -import "../components/cap-contributor-list.js"; +import { anchorLinks } from "../data/docsSidebarLinks.js"; export class CapDocsPage extends LitElement { // Turn Shadow DOM off @@ -26,6 +25,23 @@ export class CapDocsPage extends LitElement {

+ +
+

+ Accessing Data +

+

+ [We will put some documentation content about accessing data here.] +

+

+ Bulk Downloads +

+

+ [We will put some documentation content about bulk downloads here.] +

+
`; From 47d9543035e0331012edb2c626760f7ad34ec6ec Mon Sep 17 00:00:00 2001 From: R I B Z Date: Wed, 31 Jan 2024 10:25:04 -0800 Subject: [PATCH 3/4] linting --- src/data/docsSidebarLinks.js | 2 +- src/templates/cap-docs-page.js | 20 ++++++++------------ 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/src/data/docsSidebarLinks.js b/src/data/docsSidebarLinks.js index 491b87d..3cc692c 100644 --- a/src/data/docsSidebarLinks.js +++ b/src/data/docsSidebarLinks.js @@ -7,4 +7,4 @@ export const anchorLinks = [ title: "Bulk Downloads", url: "#bulk-downloads", }, -] \ No newline at end of file +]; diff --git a/src/templates/cap-docs-page.js b/src/templates/cap-docs-page.js index e5ae32f..65cacea 100644 --- a/src/templates/cap-docs-page.js +++ b/src/templates/cap-docs-page.js @@ -19,29 +19,25 @@ export class CapDocsPage extends LitElement {

- Welcome to the Caselaw Access Project Documentation. - Here you'll find some documentation about our project, - organization, data, applications, services, and site. + Welcome to the Caselaw Access Project Documentation. Here you'll + find some documentation about our project, organization, data, + applications, services, and site.

-