Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Continued docs cleanup #61

Merged
merged 9 commits into from
Apr 15, 2024
Merged

docs: Continued docs cleanup #61

merged 9 commits into from
Apr 15, 2024

Conversation

ibgreen
Copy link
Contributor

@ibgreen ibgreen commented Apr 15, 2024

Deployed at: https://visgl.github.io/deck.gl-community/docs

  • Clean up main page
  • Add badges to each module
  • Fix some titles, indentation etc.

@ibgreen ibgreen requested a review from donmccurdy April 15, 2024 17:21
@@ -1,16 +1,20 @@
# Overview

![deck.gl](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
![WebGPU](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarifying alt text:

Suggested change
![WebGPU](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")
![WebGPU not supported](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")

docs/modules/editable-layers/api-reference/edit-modes.md Outdated Show resolved Hide resolved
@@ -1,5 +1,8 @@
# Overview

![deck.gl](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
![WebGPU](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![WebGPU](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")
![WebGPU not supported](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")

@@ -1,5 +1,8 @@
# Overview

![deck.gl](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
![WebGPU](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
![WebGPU](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")
![WebGPU not supported](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. I think those are just the texts shown when hovered.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but also changes the meaning considerably for users of screen readers. :)

@ibgreen ibgreen merged commit b39b2b9 into master Apr 15, 2024
1 check passed
@ibgreen ibgreen deleted the ib/docs-polish branch April 15, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants