search

fsprojects / FAKE

FAKE - F# Make
https://fake.build
Other
1.28k stars 582 forks source link

Documentation: Fileformat for Releasenotes not rendered correctly #2729

Open jakob-ledermann opened 1 year ago

jakob-ledermann commented 1 year ago

Description

In the documentation https://fake.build/reference/fake-core-releasenotes.html for version 6.0.0-beta001 the file formats are not rendered correctly.

Repro steps

Open Page https://fake.build/reference/fake-core-releasenotes.html and compare with https://v5.fake.build/apidocs/v5/fake-core-releasenotes.html

Expected behavior

I would expect a simliar rendered Block of examples for the files.

Actual behavior

The contents of the file are rendered as any normal text without linebreaks. Therefore the Contents are not easily detectable.

Known workarounds

Look at documentation for older Versions https://v5.fake.build/apidocs/v5/fake-core-releasenotes.html

Related information

Browser used to access: Firefox 108.0.2 (64-Bit) on Win10

github-actions[bot] commented 1 year ago

Welcome to the FAKE community! Thank you so much for creating your first issue and therefore improving the project!

yazeedobaid commented 1 year ago

Thanks for reporting, can you send a PR with a fix?

jakob-ledermann commented 1 year ago

Unfortunately I do not see why the newer Documentation does not render like the old one. So I am unable to create a fix or send a PR.