chroma icon indicating copy to clipboard operation
chroma copied to clipboard

[ENH] Docs revamp prototype

Open itaismith opened this issue 1 year ago • 1 comments

Description of changes

  • Prototype for a new docs project.
  • Unified design with trychroma.com
  • Using NextJS 14 and app router.
  • Markdown management with Markdocs, but using tailwind and components instead of CSS for tags.

Test plan

  • Run npm run dev to play with

Documentation Changes

N/A

itaismith avatar Sep 30 '24 17:09 itaismith

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • [ ] Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • [ ] Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • [ ] If appropriate, are there adequate property based tests?
  • [ ] If appropriate, are there adequate unit tests?
  • [ ] Should any logging, debugging, tracing information be added or removed?
  • [ ] Are error messages user-friendly?
  • [ ] Have all documentation changes needed been made?
  • [ ] Have all non-obvious changes been commented?

System Compatibility

  • [ ] Are there any potential impacts on other parts of the system or backward compatibility?
  • [ ] Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • [ ] Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

github-actions[bot] avatar Sep 30 '24 17:09 github-actions[bot]