Skip to content

Commit

Permalink
docs: added todos
Browse files Browse the repository at this point in the history
  • Loading branch information
prjctimg committed Jun 11, 2024
1 parent 23dbf3f commit 3a426a6
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Core modules

These are functions that only consume either the Culori API or use the `fp` module. These modules are used throughout the codebase with other utilities to manipulate colors for different use cases.


<!-- This is an internal memento for myself -->
28 changes: 28 additions & 0 deletions www/.github/workflows/TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Todo

Add workflows for:

- Posting to Twitter channel
- Posting to discord channel
- Deploying website whenever any file in this dir is modified
- Workflow for synchronising wiki

## Wiki

The wiki will contain info about how each function is designed in relation to the supported color formats.

## `examples/`

For every module they'll be a complimentary `.md` or `.mdx` file with comprehensive examples. This allows us to link to An examples page for every module we document

## Module bootstrapping script

For every new module in the `./src` directory:

- Create example md file
- Create the js module
- Add them to git

## Blog progress each day, its your website mann

Create a GitHub App for xml-wizard

0 comments on commit 3a426a6

Please sign in to comment.