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.

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

Rework site documentation #4544

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Bananeweizen
Copy link
Contributor

  • fix wording and typos
  • enable syntax highlighting
  • replace tabs in code blocks for unified layout
  • upgrade skin (dependabot doesn't work for site.xml)

Be aware numbered lists don't work well here, if they have code blocks in between, because the index resets to 1 after each block. Therefore numbered lists have been replaced by bullet lists several times. An alternative might be converting to Asciidoc, which has far greater control over such things.

Copy link

github-actions bot commented Dec 18, 2024

Test Results

  603 files  ±0    603 suites  ±0   4h 19m 1s ⏱️ + 11m 33s
  432 tests ±0    422 ✅  - 2   7 💤 ±0  2 ❌ +1  1 🔥 +1 
1 296 runs  ±0  1 270 ✅  - 3  22 💤 ±0  3 ❌ +2  1 🔥 +1 

For more details on these failures and errors, see this check.

Results for commit 1facd06. ± Comparison against base commit edb9113.

♻️ This comment has been updated with latest results.


- create a file called `maven.config` in the `.mvn` folder with the following content (adjust the version accordingly!):
```properties
-Dtycho-version=4.10.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4.10.0?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good finding. Fixed :)

@laeubi
Copy link
Member

laeubi commented Dec 20, 2024

@Bananeweizen can you share a screenshot of the new layout/skin?

* fix wording and typos
* enable syntax highlighting
* enable line numbers for code blocks
* replace tabs in code blocks for unified layout
* upgrade skin (dependabot doesn't work for site.xml)
@Bananeweizen
Copy link
Contributor Author

Bananeweizen commented Dec 20, 2024

@laeubi The skin itself is the exact same. This shows left=online documentation, right=this PR. I've marked some areas with notable differences.
grafik

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants