diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5bf7514..283d99d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Ruby uses: ruby/setup-ruby@v1 with: diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 625b633..b0b2cc4 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -30,7 +30,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Ruby uses: ruby/setup-ruby@v1 with: @@ -47,7 +47,7 @@ jobs: JEKYLL_ENV: production - name: Upload artifact # Automatically uploads an artifact from the './_site' directory by default - uses: actions/upload-pages-artifact@v3 + uses: actions/upload-pages-artifact@v4 # Deployment job deploy: diff --git a/Gemfile b/Gemfile index 253fca3..7256c82 100644 --- a/Gemfile +++ b/Gemfile @@ -3,7 +3,7 @@ source 'https://rubygems.org' gem "jekyll", "~> 4.4.1" # installed by `gem jekyll` # gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 -gem "just-the-docs", "0.10.1" # pinned to the current release +gem "just-the-docs", "0.12.0" # pinned to the current release # gem "just-the-docs" # always download the latest release gem "jekyll-redirect-from" diff --git a/Gemfile.lock b/Gemfile.lock index adc83a9..3481043 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,28 +1,28 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.8.7) - public_suffix (>= 2.0.2, < 7.0) - base64 (0.2.0) - bigdecimal (3.1.9) + addressable (2.8.8) + public_suffix (>= 2.0.2, < 8.0) + base64 (0.3.0) + bigdecimal (4.0.1) colorator (1.1.0) - concurrent-ruby (1.3.5) - csv (3.3.2) + concurrent-ruby (1.3.6) + csv (3.3.5) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) eventmachine (1.2.7) - ffi (1.17.1-arm64-darwin) - ffi (1.17.1-x86_64-linux-gnu) + ffi (1.17.3-arm64-darwin) + ffi (1.17.3-x86_64-linux-gnu) forwardable-extended (2.6.0) - google-protobuf (4.29.3-arm64-darwin) + google-protobuf (4.33.4-arm64-darwin) bigdecimal rake (>= 13) - google-protobuf (4.29.3-x86_64-linux) + google-protobuf (4.33.4-x86_64-linux-gnu) bigdecimal rake (>= 13) - http_parser.rb (0.8.0) - i18n (1.14.7) + http_parser.rb (0.8.1) + i18n (1.14.8) concurrent-ruby (~> 1.0) jekyll (4.4.1) addressable (~> 2.4) @@ -47,45 +47,47 @@ GEM jekyll (>= 3.7, < 5.0) jekyll-redirect-from (0.16.0) jekyll (>= 3.3, < 5.0) - jekyll-sass-converter (3.0.0) - sass-embedded (~> 1.54) + jekyll-sass-converter (3.1.0) + sass-embedded (~> 1.75) jekyll-seo-tag (2.8.0) jekyll (>= 3.8, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - json (2.9.1) - just-the-docs (0.10.1) + json (2.18.0) + just-the-docs (0.12.0) jekyll (>= 3.8.5) jekyll-include-cache jekyll-seo-tag (>= 2.0) rake (>= 12.3.1) - kramdown (2.5.1) - rexml (>= 3.3.9) + kramdown (2.5.2) + rexml (>= 3.4.4) kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.9.0) + listen (3.10.0) + logger rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) + logger (1.7.0) mercenary (0.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (6.0.1) - rake (13.2.1) + public_suffix (7.0.2) + rake (13.3.1) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.4.0) - rouge (4.5.1) + rexml (3.4.4) + rouge (4.7.0) safe_yaml (1.0.5) - sass-embedded (1.83.4-arm64-darwin) - google-protobuf (~> 4.29) - sass-embedded (1.83.4-x86_64-linux-gnu) - google-protobuf (~> 4.29) + sass-embedded (1.97.3-arm64-darwin) + google-protobuf (~> 4.31) + sass-embedded (1.97.3-x86_64-linux-gnu) + google-protobuf (~> 4.31) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) unicode-display_width (2.6.0) - webrick (1.9.1) + webrick (1.9.2) PLATFORMS arm64-darwin @@ -94,7 +96,7 @@ PLATFORMS DEPENDENCIES jekyll (~> 4.4.1) jekyll-redirect-from - just-the-docs (= 0.10.1) + just-the-docs (= 0.12.0) BUNDLED WITH 2.5.9 diff --git a/classes-taxonomy.md b/classes-taxonomy.md index 0cde16b..102b8e6 100644 --- a/classes-taxonomy.md +++ b/classes-taxonomy.md @@ -43,13 +43,13 @@ Regions correspond with [ARIA regions and HTML5 sectioning elements](https://www ### .group -* [.index](/patterns/indexes) -* [.listbox](/patterns/listbox) -* [.meta](/patterns/meta) -* [.blurb](/patterns/blurb) -* [.preface](/patterns/preface) -* [.comments](/patterns/comments) -* [.stats](/patterns/stats) +* [.index](/docs/patterns/indexes) +* [.listbox](/docs/patterns/listbox) +* [.meta](/docs/patterns/meta) +* [.blurb](/docs/patterns/blurb) +* [.preface](/docs/patterns/preface) +* [.comments](/docs/patterns/comments) +* [.stats](/docs/patterns/stats) ### .zone @@ -153,7 +153,7 @@ These class names are almost always singular, with the exception of `tags`. * .warning-no * .warning-choosenotto * .external-work (.warnings becomes an abstract) - * .iswip (a state [modifier](#modifiers) presented as part of the `.required-tags` block in [blurbs](/patterns/blurb)) + * .iswip (a state [modifier](#modifiers) presented as part of the `.required-tags` block in [blurbs](/docs/patterns/blurb)) * .complete-yes * .complete-no * .tagset @@ -225,7 +225,7 @@ Modifiers can be grouped into these abstract classes: ### State modifiers * states (abstract) - * [.current](/patterns/actions) (navigation modifer used to indicate the current position in the navigation options) + * [.current](/docs/patterns/actions) (navigation modifer used to indicate the current position in the navigation options) * .hidden * .public (bookmark) * .private (bookmark) @@ -236,8 +236,8 @@ Modifiers can be grouped into these abstract classes: * .latest also .recent * .open * .closed - * .odd ([comment](/patterns/comments)) - * .even ([comment](/patterns/comments)) + * .odd ([comment](/docs/patterns/comments)) + * .even ([comment](/docs/patterns/comments)) * pending (abstract state) * .draft * .preview @@ -271,7 +271,7 @@ Modifiers can be grouped into these abstract classes: ### Ability modifiers -Ability modifiers apply to [interactions](/patterns/interactions). +Ability modifiers apply to [interactions](/docs/patterns/interactions). * abilities (abstract) * .draggable @@ -282,7 +282,7 @@ Ability modifiers apply to [interactions](/patterns/interactions). ### Mode modifiers -Mode modifiers apply to [interactions](/patterns/interactions). +Mode modifiers apply to [interactions](/docs/patterns/interactions). * modes (abstract) * .single @@ -291,7 +291,7 @@ Mode modifiers apply to [interactions](/patterns/interactions). ## Travellers -[Index](/patterns/indexes) is the most used example of the polyvalent "types or states of groups." +[Index](/docs/patterns/indexes) is the most used example of the polyvalent "types or states of groups." * .index * .tree diff --git a/classes.md b/classes.md index 3d7c8e6..3c24068 100644 --- a/classes.md +++ b/classes.md @@ -35,11 +35,11 @@ Our classes are how we describe and document our data, so it's very important to * [classes added by Rails](#rails-classes) * classes used by jQuery plugins, since it is easier to keep plugins up to date if we *don't* modify the class names * classes used by our own JavaScript, although classes that follow our naming system are strongly preferred -* classes used on [blurbs](/patterns/blurb) to allow muting (e.g., `work-000` and `user-000`), which are also listed last for neatness +* classes used on [blurbs](/docs/patterns/blurb) to allow muting (e.g., `work-000` and `user-000`), which are also listed last for neatness ## "What kind and where?" -It might be useful to look at some [diagrams of pages](/patterns) on our Archive to really understand that in CSS, we write a path *to* places in our HTML; we don't need to give everything a unique name, because we describe it: "what kind and where". +It might be useful to look at some [diagrams of pages](/docs/patterns) on our Archive to really understand that in CSS, we write a path *to* places in our HTML; we don't need to give everything a unique name, because we describe it: "what kind and where". For example, we use a dotted line to underline all tag links: `a.tag { border-bottom: 1px dotted; }`. If we want to change how tag links look on bookmark blurbs, we don't add a new `bookmark-tag` class in the HTML -- we just use the bookmark tags' unique path in the DOM: `.bookmark a.tag { border-bottom: none; }` diff --git a/index.md b/index.md index ad386ae..cb9a32e 100644 --- a/index.md +++ b/index.md @@ -14,23 +14,23 @@ redirect_from: These pages are, like the Archive, a work in progress. -It is not necessary to read all these pages before you start coding! Most of them are intended to be references you can use as you go along. But whether you're a beginner or have previous experience with HTML and CSS, it's very important that you familiarize yourself with [front end philosophy and structure](front-end-user-guide) as well as our [front end coding standards](coding-standards) before you submit any code that changes the front end. +It is not necessary to read all these pages before you start coding! Most of them are intended to be references you can use as you go along. But whether you're a beginner or have previous experience with HTML and CSS, it's very important that you familiarize yourself with [front end philosophy and structure](/docs/front-end-guide) as well as our [front end coding standards](/docs/coding-standards) before you submit any code that changes the front end. ## Getting started with HTML and CSS If you have only limited experience with HTML and CSS, these pages may help prepare you for working on the Archive front end. However, they are not a substitute for more comprehensive guides like [W3Schools](https://www.w3schools.com) or [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web). -1. [What is Semantic HTML?](/basics/semantic-html) -2. [What is CSS?](/baiscs/css) -3. [Writing a Skin](/basics/writing-a-skin) +1. [What is Semantic HTML?](/docs/basics/semantic-html) +2. [What is CSS?](/docs/basics/css) +3. [Writing a Skin](/docs/basics/writing-a-skin) ## How we code stuff Our coding practice may be radically different from anything you've done before. While our standards may seem limiting and fussy at first, they are designed to keep the code (and the Archive interface) as neat, consistent, and manageable as possible. -* [Coding Standards](coding-standards) -* [Style Guide](style-guide) -* [Front End Guide](front-end-user-guide) -* [Design Patterns](/patterns) +* [Coding Standards](/docs/coding-standards) +* [Style Guide](/docs/style-guide) +* [Front End Guide](/docs/front-end-guide) +* [Design Patterns](/docs/patterns) -Finally, our [Accessibility Statement](accessibility-statement) details our approach to making the Archive accessible to as many people as possible. +Finally, our [Accessibility Statement](/docs/accessibility-statement) details our approach to making the Archive accessible to as many people as possible.