MAINT - Updates post release (#34)

Author: trallard

CITATION.cff

@@ -0,0 +1,47 @@
+cff-version: 1.2.0
+title: bokeh-a11y-audi
+message: >-
+  If you use this resource, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: "Frank"
+    family-names: "Elavsky"
+    orcid: "https://orcid.org/0000-0002-6849-5893"
+    affiliation: "Carnegie Mellon University"
+  - given-names: "Gabriel"
+    family-names: "Fouasnon"
+    affiliation: "Quansight Labs"
+  - given-names: "Mateusz"
+    family-names: "Paprocki"
+    affiliation: "Bokeh, Anaconda"
+  - given-names: "Pavithra"
+    family-names: "Eswaramoorthy"
+    affiliation: "Bokeh, Quansight Labs"
+  - given-names: "Tania"
+    family-names: "Allard"
+    affiliation: "Quansight Labs"
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.14923641
+    description: Repository DOI
+repository-code: >-
+  https://github.com/Quansight-Labs/bokeh-a11y-audit/tree/main
+url: "https://bokeh-a11y-audit.readthedocs.io/"
+abstract: >-
+  Findings and progress of the Bokeh accessibility
+  audit as part of the Accessible interactive data
+  visualizations in Python with
+  Bokeh grant funded by the
+  CZI EOSS Cycle 6.
+keywords:
+  - accessibility
+  - data visualization
+  - python
+  - bokeh
+  - digital
+  - assistive technologies
+  - open source
+  - scientific computing
+  - javascript
+license: BSD-3-Clause

README.md

@@ -1,39 +1,63 @@
 # bokeh-a11y-audit
 
+| Information                 | Links                                                                                                                                                                                                                     |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Project                     | [![License](https://img.shields.io/badge/License-BSD%203--Clause-gray.svg?colorA=2b2d42&colorB=654EA3&style=flat.svg)](https://opensource.org/licenses/BSD-3-Clause)                                                      |
+| Audit findings and evidence | [![bokeh-a11y-audit documentation site](https://img.shields.io/badge/%F0%9F%93%96%20Read-accessibility%20audit%20findings-gray.svg?colorA=2b2d42&colorB=654EA3&style=flat.svg)](https://bokeh-a11y-audit.readthedocs.io/) |
+| Cite this resource          | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14923642.svg)](https://doi.org/10.5281/zenodo.14923642)                                                                                                               |
+
 Welcome to the Bokeh accessibility (a11y) audit repository!
 
-This repository is a place to track the findings and progress of the Bokeh accessibility audit as part of the
-**Accessible interactive data visualizations in Python with Bokeh** grant funded by the [CZI EOSS Cycle 6](https://chanzuckerberg.com/eoss/).
+This repository is a place to track the findings and progress of the Bokeh accessibility
+audit as part of the
+**Accessible interactive data visualizations in Python with Bokeh** grant funded by the
+[CZI EOSS Cycle 6](https://chanzuckerberg.com/eoss/).
 
-🗂️ Grant progress and deliverables are tracked in the [Quansight-Labs/czi-bokeh-mgmt repository](https://github.com/Quansight-Labs/czi-bokeh-mgmt).
+🗂️ Grant progress and deliverables are tracked in the
+[Quansight-Labs/czi-bokeh-mgmt repository](https://github.com/Quansight-Labs/czi-bokeh-mgmt).
 
 ## Contents 🗃️
 
-- [Accessibility audit findings](./source/): audits are organised in subdirectories according to the scope of the audit.
-- [Accessibility audit documentation](https://bokeh-a11y-audit.readthedocs.io/en/latest/): findings are presented in a Sphinx-generated website.
-- [Bokeh dashboard for accessibility audit](./dashboard/README.md): contains the assets and components for focused accessibility audits.
+- [Accessibility audit findings](./source/): audits are organised in subdirectories
+  according to the scope of the audit.
+- [Accessibility audit documentation](https://bokeh-a11y-audit.readthedocs.io/en/latest/):
+  findings are presented in a Sphinx-generated website.
+- [Bokeh dashboard for accessibility audit](./dashboard/README.md): contains the assets
+  and components for focused accessibility audits.
 
 ## Acknowledgements 🤝
 
 Key people involved in this project are:
 
-- Frank Elavsky (@frankelavsky) - PhD student and researcher at [Human-Computer Interaction Institute](https://hcii.cmu.edu/) at [Carnegie Mellon University](https://www.cmu.edu/)
+- Frank Elavsky (@frankelavsky) - PhD student and researcher at [Human-Computer Interaction Institute](https://hcii.cmu.edu/)
+  at [Carnegie Mellon University](https://www.cmu.edu/)
 - Gabriel Fouasnon (@gabalafou) - Senior Software Engineer at Quansight Labs
-- Mateusz Paprocki (@mattpap) - Open Source Software Engineer at Anaconda, Co-creator and Core Team Member of Bokeh
-- Pavithra Eswaramoorty (@pavithraes) - Developer Advocate at Quansight, Core Team Member of Bokeh
-- Philipp Rudiger (@philippjfr) - Principal Software Engineer at Anaconda, Core Team Member of Bokeh
+- Mateusz Paprocki (@mattpap) - Open Source Software Engineer at Anaconda, Co-creator
+  and Core Team Member of Bokeh
+- Pavithra Eswaramoorty (@pavithraes) - Developer Advocate at Quansight, Core Team
+  Member of Bokeh
+- Philipp Rudiger (@philippjfr) - Principal Software Engineer at Anaconda, Core Team
+  Member of Bokeh
 - Smera Goel (@smeragoel) - UI/UX Designer at Quansight Labs
 - Tania Allard (@trallard) - Co-director at Quansight Labs
 
-This project is funded by the [CZI Science EOSS](https://chanzuckerberg.com/eoss/) program (Cycle 6).
+This project is funded by the [CZI Science EOSS](https://chanzuckerberg.com/eoss/)
+program (Cycle 6).
+
+The [Bokeh](https://bokeh.org/) project is sustained by the [Bokeh Development Team
+(@bokeh/dev)](https://github.com/orgs/bokeh/teams/dev).
+
+## Contributing 🤗
 
-The [Bokeh](https://bokeh.org/) project is sustained by the [Bokeh Development Team (@bokeh/dev)](https://github.com/orgs/bokeh/teams/dev).
+We welcome contributions to this project! Please read our contribution guidelines in the [contributing doc](./contributing.md) in this repository.
 
 ## License 📃
 
 The code in this repository is licensed under the terms of the revised [BSD license](./LICENSE).
-Content and other assets are licensed under the terms of the [Creative Commons Attribution-NonCommercial 4.0 International License](https://creativecommons.org/licenses/by-nc/4.0/).
+Content and other assets are licensed under the terms of the
+[Creative Commons Attribution-NonCommercial 4.0 International License](https://creativecommons.org/licenses/by-nc/4.0/).
 
 ## Code of Conduct 📖
 
-All communication in this repository is covered by [Quansight Code of Conduct](https://github.com/Quansight/.github/blob/master/CODE_OF_CONDUCT.md).
+All communication in this repository is covered by
+[Quansight Code of Conduct](https://github.com/Quansight/.github/blob/master/CODE_OF_CONDUCT.md).

contributing.md

@@ -13,44 +13,54 @@ The audit findings are organized and presented with [Sphinx](https://www.sphinx-
 - Ensure every page follows the heading hierarchy: H1, H2, and so on.
 - Use the following syntax for embedding images:
 
-  ````
-    ```{figure} relative_path_to_image.png
-        :width: 100%
-        :alt: Alt-text for the imahe
+  ````md
+  ```{figure} relative_path_to_image.png
+      :width: 100%
+      :alt: Alt-text for the image
 
-        A scatter plot is shown. A plotting tool button is toggled active on the right. The contrast checking score is shown on the bottom left corner (fails).
-    ```
+      A scatter plot is shown. A plotting tool button is toggled active on the right. The contrast checking score is shown on the bottom left corner (fails).
+  ```
   ````
 
+- Add meaningful alt-text to images.
 - Use the following syntax for embedding videos:
-  ````
-    ```{video} relative_path_to_video.mp4
-    :width: 100%
-    :playsinline:
-    ```
+
+  ````md
+  ```{video} relative_path_to_video.mp4
+  :width: 100%
+  :playsinline:
+  ```
   ````
 
 ### Build documentation locally (optional)
 
 For major updates to the documentation website, it's useful to test your contributions with a local live development of the website. You can build it with the following instructions.
 
 1. Fork and clone the repository:
-   ```
+
+   ```sh
    git clone https://github.com/<your_username>/bokeh-a11y-audit.git
    ```
+
 2. Create a [conda](https://docs.conda.io/projects/conda/en/stable/#) environment with the required dependencies and activate it:
-   ```
+
+   ```sh
    conda env create -f environment-docs.yaml
    conda activate bokeh-a11y-docs
    ```
+
 3. Install pre-commit hooks (for linting and formatting):
-   ```
+
+   ```sh
    pre-commit install
    ```
+
 4. Start a live deployment of the documentation website:
-   ```
+
+   ```sh
    sphinx-autobuild source build/html
    ```
+
    Your local website will be available at [localhost:8000](http://127.0.0.1:8000).
    This site is re-built when you save local changes.