dhershman1 / dusty-codes-site

Demo site for my front end based node modules/libraries.

Welcome

Hello! 👋 Welcome to my profile

I'm Dustin, a Fullstack Software Engineer,

I'm a Functional Developer at heart, and my most used toolset/language is JavaScript. I've authored many cool and fun libraries for the language!

I'm always looking to expand my horizons though and I've been delving little by little into other languages like Haskell, Clojure, Elm, and Scheme/Racket!

Thanks for taking the time to read this, check out my toolsets and feel free to ask questions/open issues/contibute where you see fit.

dusty-codes-site's Issues

Slow Response Times

Looks like the requests to get the json files through the CDN request is a bit slow especially for libraries like Kyanite which has a lot of functions to document. This will need either an alternative route or better optimization around the request itself to improve load times.

Methods Optimizations

Should we paint methods as one giant piece and anchor headers? this eliminates the jerky motion of clicking an item from the mehods bar and being shot to the top of the page.

However this could also be remedied with a smoother transition into the new method rather than suddenly being jolted to the top of the page.

Fix Nav Drawer being unscrollable

The Nav Drawer is rather static in the case that you can't scroll down if it exceeds screen height and the content does not. This doesn't seem to apply to the drawer built for navigating methods in the docs however.

Add ability to pause animated background

The background animation currently does not have an ability to pause it which may be an accessibility issue.

I want to give the ability to pause it

Break down pages

With the new flow of documentation for each library/module it might be a good time to break them down even more into a component layout per page, since each page can be a bit more dynamic now in how it fetches content with the generated json files.

Once issues #10 and #11 have finished up we should have no problem doing this

Link directly to documentation of specific function

Is your feature request related to a problem? Please describe.
No problem, just an enhancement

Describe the solution you'd like
I would like to be able to link directly to the documentation of a specific function.

Describe alternatives you've considered
Currently, I just have a general documentation link within the readme of my tutorial.

Make sure Floating Buttons are accessible

The application uses several floating buttons such as the back to top one, the mobile button for opening nav drawer for method documentation, as well as the button for opening the overall site navigation.

These may fall short in terms of accessibility so I will want to make sure you can use them no matter what.

Assign REPL Functionality

Let's get some REPL functionality built into the app so users are able to play around with functions. Whether to test something they want to do, or to test to make sure the library is something they want to use.

Make it more obvious on docs what clicking the button does

Currently I have a button in place to switch between info and methods documentation.

I think it'd be a good idea to instead perhaps tab this out allowing to break down info into different tabs, as well as making it so the buttons can each be read off by a screen reader more easily

Add Links to relevant info

We can expand upon the info.json we fetch from the CDN.

We can either go the more light weight route which is to add links to the relevant files we need to also request to fill out the site.

OR

We can simple include that data on those files already as Strings. The downside to this method is it's going to bloat the info.json file by quite a lot since right off the bat it will need to contain both the README and CHANGELOG markdown files as strings. While neither of these are true to form giant, it's still a heafty string.

The downside to BOTH methods, is that this will require changes at the module level on all 4 modules. Which may or may not be a good/bad thing.

If other routes found I will add them onto this issue as potential candidates.

Fix compose documentation

comp(199) => Math.sqrt(200) => ~14.14
comp(399) => Math.sqrt(400) => 20

Better Alternate Attributes for Images

I should go through and make sure each image that is used also has a alternative attribute, as well as making sure that this alt text is informative to what the image is suppose to be.

Making sure that even if the content isn't there we still know what it is, or what it should be.

More/Better Toolips

A good portion of the application site is lacking in information or tooltips on elements. Might be worth going through to assure these are present.

Possible webhook integration

I think it's a good idea if we start using github webhooks or something along those lines vs using something like a CDN solution which we currently rely on.

Why? Well the CDN takes a hot minute to catch up to recent version releases of the libraries that are documented on the site.

We can use the webhook to send the json stuff we need to the site to keep a hold of it, then we will always have up to date information vs say waiting for the CDN to catch up?

Fix html lang attribute

There doesn't seem to be a lang attribute for the html tag, might be worth digging into so I can fix this.

Improve Documentation Experience

The current experience for libraries like Kyanite, and Phone-Fns. However for libraries with a primary function such as Simply_Valid and Simple-Card it doesn't work as nicely.

Maybe add something to their info.json the site can look at to render a better view for their code.

Just so we can focus on the full use case of the library itself.

Convert simple-card

Simply_Valid, and Kyanite have both been converted to the new documentation flow for the site.

Now it's time to also convert the simple-card page to this flow so it can be more automated and easily maintained.

Nav Drawer Viewability on Smaller screens

The Nav Drawer is kind of hard to view on smaller screens (Mainly on smaller laptop screens)

The nav drawer is cut off at certain points on certain screen sizes, this makes navigation more of a pain in the site.

Possible solution:

• Shrink the nav drawer down
• Make the nav drawer scrollable
• Make the nav drawer scroll with the page itself

Make sure Nav Drawer is screen reader friendly

Since the Nav Drawer is Key to navigating the application it will be very important to make sure it is able to be used with a screen reader and keyboard.

This same issue goes for the nav drawer on mobile when the methods are hidden away inside of one.

Stabilize New Store System

With the introduction of a Vuex store for handling a lot of the documentation setup there are a lot of what ifs and unknowns introduced.

This is simply because a very minimal concept is what I wanted to shoot for, which is done now I need to hunker down and optimize that before it can go to Production.

Some small things like only fetching a copy of a modules json and markdown files if we need to would be great. If they visited this module went to another page (like the documentation portal or portfolio pages) then use whats in the store rather than going out and grabbing the info all over again.

Convert Phone-Fns

Like issue #10 we should also convert phone fns to this new format to keep it easier to update and maintain in the long run

correct definition of includes()

The word "at" is repeated and one should be removed.

Also, in the Arguments section, the type of list should be array or string.

Scrolling Window

It is frustrating when the screen scrolls all the way up and then I need to scroll all the way down to look at the next function. It happens a lot when I am looking through to see what is available.

Describe the solution you'd like
The function documentation window shows up wherever the page is, not just at the top.

Describe alternatives you've considered
I just deal with it. It isn't that big of a deal