Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update README and Wiki #115

Open
Schmoho opened this issue May 10, 2022 · 1 comment
Open

update README and Wiki #115

Schmoho opened this issue May 10, 2022 · 1 comment
Assignees
@Schmoho
Labels
2.1 Issue in the 2.1 branch documentation
Milestone
documentation is ...

Comments

@Schmoho
Copy link
Collaborator

Schmoho commented May 10, 2022 •
edited
Loading

The documentation is not very inviting currently.

  • in the first paragraph we greet the user with a troubleshooting hint -> can be moved to a troubleshooting page in the wiki
  • notes for developers on how to build the project can be moved to the wiki
    also, the building instructions reference the lightJar gradle task, which our configuration does not include
  • "how to cite" groups more naturally with the heading licenses
  • we have no user documentation that actually explains what exactly the user can expect the ModelPolisher to do -> wiki page
@Schmoho Schmoho added this to the documentation is up to date milestone May 10, 2022
@Schmoho Schmoho self-assigned this May 10, 2022
Schmoho added a commit that referenced this issue May 10, 2022
@Schmoho
issue #115: update README.md
853c1b8
Schmoho added a commit that referenced this issue May 10, 2022
@Schmoho
issue #115: fix link in README, further work on #105 will come via 85…
ed4e3a8 
…3c1b8
Schmoho added a commit that referenced this issue May 10, 2022
@Schmoho
issue #115: fix link in README, further work on #115 will come via 85…
96c5991 
…3c1b8
Schmoho added a commit that referenced this issue Jun 21, 2022
@Schmoho
issue #115: update README.md
4b8cc82
@GwennyGit
Copy link

For users who need to install docker before using ModelPolisher links to the corresponding installation guides would be a nice addition for the documentation.

For example:

How to install docker:

Schmoho added a commit that referenced this issue Jun 11, 2024
@Schmoho
issue #115: update README.md
50b15d5
Schmoho added a commit that referenced this issue Jul 26, 2024
@Schmoho
issue #115: update README.md
81618c5
@Schmoho Schmoho added the 2.1 Issue in the 2.1 branch label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Schmoho Schmoho

Labels
2.1 Issue in the 2.1 branch documentation
Projects
None yet
Milestone
documentation is up to date
Development

No branches or pull requests
2 participants
@Schmoho @GwennyGit