playframework / playframework/playframework.com
Search results should contain hints if page is Java or Scala
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 44
- Forks
- 62
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 3
Description
It's annoying to not see at first glance if a page is for the Scala or the Java API .This bothers me a long time already actually:
Suggestion:
Maybe this could be handled by adding tags for Java/Scala and somehow display that tag in the result heading? Like the language tag we add for
https://github.com/playframework/playframework.com/blob/be78c29a074d94ea3bacef3f30b04be2c9f760e8/app/views/documentation/algolia.scala.html#L14
https://github.com/playframework/playframework.com/blob/188aecaacc56f06edccd64ed2ea653d151cc5f12/app/views/documentation/header.scala.html#L24-L26
Just an idea however, not sure if that works.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading app/views/documentation/algolia.scala.html around the existing language tag and app/views/documentation/header.scala.html around the documented language display. Trace how search result headings are rendered and determine how Java or Scala identification can appear there; done means results visibly distinguish the Java and Scala APIs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, scala
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100