docs: drop redundant conventions doc covered in the wiki#14863
Conversation
calcite-admin
added
the
skip visual snapshots
isaacbraun
left a comment
isaacbraun
left a comment
There was a problem hiding this comment.
Nice! Didn't realize these were duplicated 🧹 It does look like there are quite a few differences though, so we might want to audit the Wiki pages and updated it where necessary before/after we remove these. @DitwanP is this something you'd want to do since you worked on the Wiki recently?
| @@ -1,64 +0,0 @@ | |||
| # Accessibility | |||
There was a problem hiding this comment.
The Accessibility page in the wiki attempts to use some custom formatting, Calcite Chips, etc. for the checklists. It doesn't appear to be working, any reason not to update it to use the default markdown checklist that was in this file?
| @@ -1,107 +0,0 @@ | |||
| # Documentation | |||
There was a problem hiding this comment.
This this content is more up-to-date than the Wiki, especially the new @copyDoc and deprecated guidance here and old Stencil references there.
|
|
||
| - [Google Web Component Best Practices](https://developers.google.com/web/fundamentals/web-components/best-practices) | ||
| - [Custom Element Conformance - W3C Editor's Draft](https://html.spec.whatwg.org/multipage/custom-elements.html#custom-element-conformance) | ||
| - [Internal Tooling and Guidlines for Building Components](webgis.esri.com/components/lumina/introduction) |
There was a problem hiding this comment.
On a quick skim, this doc is also missing some content on the Wiki, including this line. It also has some old Stencil references.
| } | ||
| ``` | ||
|
|
||
| ## Light Mode/Dark Mode |
There was a problem hiding this comment.
Light/dark section is outdated as well for Styling doc.
| @@ -1,104 +0,0 @@ | |||
| # Tests | |||
There was a problem hiding this comment.
Think the Testing doc is more up to date on the wiki, but not sure.
| // accessible() will test for a11y | ||
| it("is accessible", async () => accessible(`<calcite-tree></calcite-tree>`)); | ||
|
|
||
| // Multiple a11y tests can be present in a component | ||
| it("is accessible: with nested children", async () => | ||
| accessible(` | ||
| <calcite-tree lines> | ||
| <calcite-tree-item> | ||
| <a href="#">Child 2</a> | ||
| <calcite-tree slot="children"> | ||
| <calcite-tree-item> | ||
| <a href="http://www.esri.com">Grandchild 1</a> |
There was a problem hiding this comment.
Wiki differs as shown below, not sure which is correct.
// describe function, identify the component
describe("calcite-tree", () => {
// accessible() will test for a11y
it("is accessible", async () => accessible(`<calcite-tree></calcite-tree>`));
// Multiple a11y tests can be present in a component
it("is accessible: with nested children", async () =>
accessible(`
<calcite-tree lines>
<calcite-tree-item>
<a href="#">Child 2</a>
<calcite-tree slot="children">
<calcite-tree-item>
<a href="http://www.google.com">Grandchild 1</a>
|
@isaacbraun 😲 I wasn't aware of these duplicates either, but yeah I can update the wiki pages based on the feedback on this PR. 👍 |
Awesome! 🤜💥🤛 There's definitely some things I missed too, worth a good pass. |
4 participants
Related Issue: N/A
Summary
✨🧹✨