docs: Add a bunch of TODO items

This commit is contained in:
Price Hiller 2024-08-29 16:17:16 -05:00
parent 4d79579baf
commit 36d1bf93c2
Signed by: Price
GPG Key ID: C3FADDE7A8534BEB

View File

@ -1,10 +1,59 @@
#+filetags: blog #+filetags: blog
* TODO Migrate to using Treesitter for syntax highlighting
SCHEDULED: <2024-07-06 Sat>
Take a look at the [[file:./src/syntax/tree_sitter_adapter.rs]] file. * TODO Add logging via tracing for builds
SCHEDULED: <2024-08-29 Thu>
* TODO Show type of language at the top of each language block - Should make it easier to tell when things are going wrong
SCHEDULED: <2024-07-06 Sat> * TODO Clean up main function
SCHEDULED: <2024-08-29 Thu>
Currently our code blocks do not display the language they are written in, would be good to show them. - Currently a lot of spaghetti
- Should separate each concern into its own function at a minimum
- E.g. Rendering of the tags page should be separated from rendering of the articles
* TODO Improve Nix flake [0/4]
SCHEDULED: <2024-08-29 Thu>
- [ ] Integrate a spellcheck on build
- [ ] Integrate with something like ~cranelib~ to improve caching for local development
- [ ] Provide a NixOS module to host with Nginx by default
- Should clean up some config from my NixOS setup
- [ ] Make the ~nix run~ command start up a local dev server for the blog
- Provide something in the ~apps~ output for this probably using ~liveserver~
- [ ] Do not use ~flake-utils~, totally unnecessary
* TODO Optimize for network data [0/2]
SCHEDULED: <2024-08-29 Thu>
- [ ] Minimize CSS
- [ ] Minimize HTML
- [ ] Lazy load everything possible
- See [[https://developer.mozilla.org/en-US/docs/Web/Performance/Lazy_loading]]
* TODO Support Github style =TIP=, =INFO=, etc. tags
SCHEDULED: <2024-08-29 Thu>
* TODO Generate table of contents for headings
SCHEDULED: <2024-08-29 Thu>
* TODO Integrate ~Treesitter~ syntax highlighting
SCHEDULED: <2024-08-29 Thu>
- Somehow get this to play nice with Nix, 🙏
* TODO Show programming language/details for code blocks
SCHEDULED: <2024-08-29 Thu>
- At the top left of code blocks display the type of language, a language icon, and maybe a filename?
- Something like ~rust treesitter_adapter.rs~
* TODO Fonts [0/2]
SCHEDULED: <2024-08-29 Thu>
- [ ] Bundle a nerd font for the page so Nerd Fonts show up correctly
- [ ] Fix oversized font sizes when phones/mobile devices are rotated
* TODO Imrpove vertical margins between paragraphs
SCHEDULED: <2024-08-29 Thu>
- Currently the vertical separation is far too much, makes it hard to read