Arnout Engelen

scoping of settings (e.g. 'sourceDirectory in (Compile, paradox)')

1

For some reason, to set the 'sourceDirectory', you must set `sourceDirectory in (Compile, paradox) := ...` (aka `Compile / paradox / sourceDirectory := ...`). It would be nicer if it...

Google appears to like that better Needs testing

Guidance on how to use includes

2

With the 'includes' feature, it seems to make sense to have .md files whose only goal is to contain snippets for inclusion in other pages. It seems to make sense...

When creating canonical links is enabled, it seems spurious `../` are added to the URL when the page is not in the root of the documentation, and also not in...

It would be neat to provide a task that produces a zipped version of the Paradox documentation, that can then be easily included in a release process.

'normal' links take a .html parameter (`[foo](foo.html)`), while `@ref` links and ToC entries expect `[foo](foo.md)`. This can be easy to mix up: `@ref`s and ToC entries are checked, but `[foo](foo.md)`...

Markdown links are not always handled correctly

2

In Alpakka, we have the link: ``` Please visit the [Slick documentation for `DatabaseConfig.fromConfig`](http://slick.lightbend.com/doc/3.2.1/api/index.html#slick.jdbc.JdbcBackend$DatabaseFactoryDef@forConfig(String,Config,Driver,ClassLoader):Database) for the full list of things to configure. ``` which is not rendered correctly (https://developer.lightbend.com/docs/alpakka/current/slick.html?language=java#starting-a-database-session)

When moving/renaming pages, links to the 'old' page (either indexed ones, external sites or 'visit this page in the latest version'-links) will break. It might be neat to be able...

To keep a documentation base consistent, it might be nice to standardize on not having trailing whitespace (as promoted by many editors and git tools). It'd be nice to have...