Good morning! The markdown for the functions table...

# http4k

[Ed Brindley]

Good morning! The markdown for the functions table isn't rendering correctly on this page https://www.http4k.org/api/org.http4k.filter/-server-filters/#functions

[Ed Brindley]

Also it would be great if the page titles were better for the API pages - google search results are often not easy to parse with them all having the title "api | holds the markdown for the http4k API"

[Ed Brindley]

image.png

[Ed Brindley]

I guess some way to get https://www.http4k.org/api/http4k-core/org.http4k.filter/-server-filters/index.html to rank higher in google than https://www.http4k.org/api/org.http4k.filter/-server-filters/ :)

[Ed Brindley]

Or not publish the second?

[s4nchez]

All those issues are related to Dokka, which has proven to be a pain to configure properly.

[s4nchez]

Or not publish the second?

If you have suggestions on how to do so, we're happy to make the change or merge a PR 🙂

[s4nchez]

This is how we're configuring it: https://github.com/http4k/http4k/blob/master/gradle/gradle-plugins/src/main/kotlin/org/http4k/api-docs.gradle.kts

[Ed Brindley]

Thanks. Will raise a PR if I can see any way to make an improvement!

[s4nchez]

Thank you. The publishing is done here: https://github.com/http4k/http4k/blob/master/.github/workflows/release_api.yaml

[Ed Brindley]

Looking in https://github.com/http4k/api/tree/master I see there is rendered HTML with recent commit dates and markdown that hasn't changed for 5 years

[Ed Brindley]

Is the "bad" content is coming from the old markdown? - It looks that way - i.e. the content on https://www.http4k.org/api/org.http4k.filter/-server-filters/ is out of date vs https://www.http4k.org/api/http4k-core/org.http4k.filter/-server-filters/index.html

[Ed Brindley]

I'm wondering if the fix is expunging the old markdown from the API repository - that could be an easy fix!

[Ed Brindley]

Hey @s4nchez, I think that is the fix - remove the .md files from the api repo that are being built by Jekyll in the "pages build and deployment" github action. https://github.com/http4k/api/actions/runs/12843869886/job/35816293011

[Ed Brindley]

and then possibly remove the "Build with Jekyll" step as that seems unneeded when the other pages are already rendered by dokka

[Ed Brindley]

I can't see the workflow definition for "pages build and deployment" though?

[s4nchez]

I'm not sure there's a specific worflow for the APIs. We just push content to the repo and GH Pages publishes it under /api.

[s4nchez]

Hmm I think deployments are not visible for people outside the http4k org

[Ed Brindley]

I can see those deployments

[Ed Brindley]

If you click on view logs for the last deployment, you can see it's doing the md -> html rendering in the build step https://github.com/http4k/api/actions/runs/12843869886/job/35816293011

[s4nchez]

So you reckon we should just remove all .md files from that repo?

[Ed Brindley]

I think so.

[Ed Brindley]

I guess the jekyll build step is harmless - it will just have nothing to process

[s4nchez]

I'm giving it a try

[s4nchez]

The invalid pages are gone. Unfortunately, it'll take a while for Google to catch-up on those changes

[Ed Brindley]

Awesome!

[Ed Brindley]

I think this will be win long term

[Ed Brindley]

People I work with always seem to end up on those old pages 😄

[s4nchez]

Absolutely. Thank you for reporting and looking into it. I wouldn't chase it otherwise 😉

[Ed Brindley]

No problem