search

curveball / browser

A HAL browser middleware for node.js
MIT License
43 stars 5 forks source link

Come up with a standard link that's a short description for the current resource #26

Open evert opened 6 years ago

evert commented 6 years ago

Not sure what the rel should be.

If this link appears, it should automatically embed the description in the page. It can serve as a tiny bit of documentation, supporting markdown. It should be a specific rel and specific type.

joshco commented 6 years ago

I often use the 'title' attribute of the self link for this

evert commented 6 years ago

Hey Josh, I am actually using the title property to populate the H1 tag.

What actually inspired this is an Apache feature:

https://wiki.apache.org/httpd/DirectoryListings

I've always been a bit obsessed with self generating interfaces, and I remember customizing my Apache directory indexes way back when I first started using the internet.

What's nice is that the header/footer feature potentially allows a lot more content.