TotalCross / TotalCross/totalcross

Sort out javadoc content and clear 404 errors

Open
#136 0 comments 0 reactions 1 assignee View on GitHub

@flsobral is already working on this.

Since Sep 17, 2020.

documentation
Dominant language
Java
Stars
227
Forks
42
Avg merge
1d 19h
Merged PRs (30d)
11

Description

Issue Title

Sort out javadoc content and clear 404 errors.

Describe the bug

Sort out javadoc content: TotalCross javadoc today includes both tc.* and totalcross.* packages. I understand that separating the SDK doc from the converter & packaging doc could improve understanding both for users and contributors, as well as being a step forward in improving documentation.

Clear 404 errors: selecting "All Classes" a large number of classes is displayed with "Sever Error 404 - file or directory not found". This makes for a poor experience when browsing the documentation, which we most certainly want to avoid ;)

The image below shows one instance of this error, but at least most of the classes named BC*_* have the same issue.
image

Additional context

Not applicable.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.