Skip to main content

dev-work-protocols-and-todo

Remember that we can use Mermaid for diagramming. Mermaid

ToDo: Add algolia to enable search Algolia

Note about MDX

  • .mdx files may have react components... this means that to get a proper preview we must run the dev server (we can't simply use a markdown previewer in vs code)
  • we also dont get the nice code coloring like we do with regular .md files (e.g bold blue titles, orange link text, etc.) (likely could set this up easily... it's just an effort)

Home Rotator

See home-shuffler.md. Goal of the different layouts: Different ways to explore the content Goal of the shuffler: Zeigarnik effect

Youtube, Text, side-by-side component

Create a little component that allows you to see the text, the youtube video, or both side by side. (Maybe like a toggle but with 3 states instead of the normal 2)

These will probably be used on every "Interview Resources" page.

Behavior: If no Youtube video has been recorded, then put a placeholder that explains there isn't a yotube video yet.

Compile time tool to extract info from all notes in a directory and write to another note

  • I already have a bunch of tools tha read all markdowns in the directory... i guess a key thought here is that we want to mark our generated files with something so I know they arent hand crafted (maybe a title prefix e.g. gen_)
  • Language Learning Hacks: See chatGPT, need to write plugin - see if I can create a list programmatically in the general file

.md front matter audit tool.

Basic implementation done. See the main README

Acronym Popup

I am thinking a popup for when using acronyms could be helpful...

Flow (For Current Navigation)

So I was in the !Technical section and it went from the about section to some random business concepts (with the next page option at the bottom). this flow was jarring). Review all sections to make sure there are (the correct) category pages after the intro Technical: About straight to other (not what I want) !Technical: About to Misguided Decision making (not what want)

I'm thinking each major section should go from about to a sort of table of contents that mirrors the side nav

Auto Tag Generation

I found a tool that already does this... but I've also been good with manual paste into chatGPT... (since i get to do manual review of output)

APIs

Maybe the auth/profile could actually be something that people unlock via easter eggs... they would get a popup telling them that they need to find the easter egg in order to create an account

So here is the idea, everything would be visible to everyone (or maybe not???), but in order to contribute you would need to login. But I want to make it attractive to find the easter eggs, so how do I do this?

Implementation: You could create some special syntax like {auth=adminsOnly}, {auth=basicUser}, etc. The second part would be stored in like a row level security style table and then the proper formatting would be applied to the note before it is delivered to the frontend

See auth-aware-delivery.md for more details

Community Feedback APIs

Note: Look for PK_API to find outstanding API tasks. Note: Some of these endpoints could definitely be combined, e.g. vote, comment. ...and if RDBMS, would use quasi- EAV e.g.

content groupitemIduserIdvote directiondate
book reviewbookReview_id_1example_user_id_1upvote/downvoteYYYY-MM-DD
proto productprotoProduct_id_1example_user_id_2upvote/downvoteYYYY-MM-DD
book reviewbookReview_id_2example_user_id_1upvote/downvoteYYYY-MM-DD

this is obviously a rough draft... I'd probably just make user + item the PK and then have a lastUpdateDt, and initialVoteDt (for when people switch their votes)... note sure I care to capture the history (type 2 SCD)... it's probably pretty rare that someone goes in several days or months later to change their vote and I dont see the business value in this case

...same thing for the comments table

See planned-endpoints.md for more details

API Architecture Ideas

Normal docker container setup on ec2