Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.

Documentation rework #1481

Open
rhuss opened this issue Jan 9, 2019 · 2 comments
Open

Documentation rework #1481

rhuss opened this issue Jan 9, 2019 · 2 comments
Labels
cat/documentation Documentation work needed status/never-stale Pin this issue to get never marked as stale by stale-bot

Comments

@rhuss
Copy link
Contributor

rhuss commented Jan 9, 2019

Documentation is incomplete and outdated
Documentation should be close to the generated standard Maven Plugin Documentation format.

This work should be tackled for the new rebranded fmp.

@lordofthejars
Copy link
Contributor

After documentation is updated, the generation of documentation could be rendered using Antora (https://antora.org/). Here you can see an example https://lordofthejars.github.io/diferencia-docs-site/diferencia/0.5.0/index.html

Also, there is an Antora Maven plugin to generate it.

@rohanKanojia rohanKanojia added the cat/documentation Documentation work needed label Jan 10, 2019
@stale
Copy link

stale bot commented Apr 10, 2019

This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions!

@stale stale bot added the status/stale Issue/PR considered to be stale label Apr 10, 2019
@rhuss rhuss added status/never-stale Pin this issue to get never marked as stale by stale-bot and removed status/stale Issue/PR considered to be stale labels Apr 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cat/documentation Documentation work needed status/never-stale Pin this issue to get never marked as stale by stale-bot
Projects
None yet
Development

No branches or pull requests

3 participants