Skip to content

Conversation

@jlevydev
Copy link
Owner

@jlevydev jlevydev commented Aug 20, 2025

Current State:

  • Dynamic modules page with search by title, direct/sub, category
  • Changes to the corresponding scripts to generate the module.json that includes both bot and human created content in the structure for the side bar object
  • Modules can have arbitrary bot/human written content displayed correctly. See aws_vpc as an example. Has some example docs with both flat and nested folder structures

Still TODO:

  • Search with Algolia
  • Prettier module names
  • Some general sidebar clean up so that clicks on the parent categories of the side bar aren't dead links

Questions:

  • Wrote a quick javascript script to create the module.json (or technically enhance the output from the original script). This seems like something that would fit well into the cli more broadly. It's simple, but probably best to have tests around. Curious your thoughts on the general pattern and where to fit it into the typescript cli? I personally think crawling the file system on a pre-commit hook so the side bar can be partially static partially dynamic is a good balance for now. Let me know your thoughts

Copy link

@fullykubed fullykubed left a comment

Choose a reason for hiding this comment

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

Only use typescript or bash for scripting. no js

Copy link

@fullykubed fullykubed left a comment

Choose a reason for hiding this comment

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

I cant tell if the new markdown content is just placeholder or not but it has tons of errors so I am just assuming it was for testing purposes. I'd like to confirm though.

<label for="module-search" class="block text-sm font-medium text-primary">
Search Modules
</label>
<input

Choose a reason for hiding this comment

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

interactive elements must use kobalte. see styleguide


// Filter modules based on search and filters
const filteredModules = createMemo(() => {
return props.modules.filter(module => {

Choose a reason for hiding this comment

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

needs to do fuzzy and relevancy search

return type.charAt(0).toUpperCase() + type.slice(1);
}

function formatGroupTitle(group: string): string {

Choose a reason for hiding this comment

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

this isnt correct logic

Choose a reason for hiding this comment

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

same as above. would rather have a static mapping with a fallback.

this fails for aws

}));
}

function formatTypeTitle(type: string): string {

Choose a reason for hiding this comment

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

id rather just have a static mapping with this as a fallback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants