Skip to content

Design md#332

Draft
Jeremy-Walton wants to merge 11 commits into
mainfrom
design-md
Draft

Design md#332
Jeremy-Walton wants to merge 11 commits into
mainfrom
design-md

Conversation

@Jeremy-Walton
Copy link
Copy Markdown
Member

Task

Rough work. Mostly sketching out the possibilities.

if (key in target && typeof target[key] === 'object' && !Array.isArray(target[key])) {
deepMerge(target[key], source[key])
} else {
target[key] = source[key]

## Format and tone

- Write for a developer who knows CSS but is new to Optics
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is probably the wrong format and tone. Would need to tune for the desired DESIGN.md format

@@ -0,0 +1,42 @@
---
name: wrap-up
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is very generic right now and should be tuned for Optics specifically. I've been doing some experiments on other projects for better AGENTS structure that could eventually be incorporated here.

Comment thread .claude/settings.local.json Outdated
Comment thread plans/DESIGN_MD_NOTES.md

## Notes

* Colors are limited to Hex in srgb. This means that hsl is not supported and colors have to be converted when generating a DESIGN.md document.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This was initial notes that probably can go away

Comment thread plans/DTCG_TOKENS_PLAN.md

## Goal

Generate a `dist/design-tokens.json` file from the Optics CSS token source files that conforms to the [Design Tokens Community Group (DTCG) spec](https://tr.designtokens.org/format/).
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This script is still in progress. Not sure it is capturing all the necessary variables. I think it is missing component specific stuff at the moment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This plan can go away once this script is finished

Comment thread AGENTS.md

## Key constraints

- No JavaScript in components. Interactivity is handled by consumers.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Or natively supported HTML + CSS interaction

Comment thread Light Theme.tokens.json Outdated
Comment thread Value.tokens.json Outdated
return sg ? `{op-color.${sg}.${after.slice(sg.length + 1)}}` : `{op-color.${after}}`
}

function parseColors() {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants