typelevel / typelevel/fs2

`microsite / tlSitePreview` does not show the static website correctly

Open
#3,433 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Scala
Stars
2.5k
Forks
636
Avg merge
2d 4h
Merged PRs (30d)
7

Description

When running the SBT command microsite / tlSitePreview on the root project folder, the generated site does not show the contents properly, although microsite / tlSite works as usual.

A screenshot of the site after running the command:
Screenshot 2024-05-14 110701

As @TonioGela pointed out, looks like it is not placing the correct files in the intended folder.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the root project configuration used by the SBT commands microsite / tlSitePreview and microsite / tlSite. Run both commands and compare which files each places in the generated site directory. Done means tlSitePreview displays the static website contents correctly, matching the working tlSite output.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.