beyond-all-reason / beyond-all-reason/RecoilEngine

Site API listing complaints (compared to old spring wiki)

Open
#1,430 20 comments 0 reactions 0 assignees View on GitHub
area: documentation
Dominant language
C++
Stars
679
Forks
290
Avg merge
3d 2h
Merged PRs (30d)
40

Description

1) it's just a significantly worse layout. The page shows 3 callins in the space that the old page could show 10. Seeing nearby callins all at once helps you see related things which might be more like what you need, and it makes it much easier to scroll through and search for what you want. And the new one doesn't have the colored syntax highlighting.
![image](https://github.com/beyond-all-reason/spring/assets/2573076/8d54aa24-6cc6-4a03-bbb8-3cc309790609)
vs
![image](https://github.com/beyond-all-reason/spring/assets/2573076/34922070-3d68-4f1b-8dc9-10700e85349d)

2) the formatting for particularly complicated callins is broken/confusing
![image](https://github.com/beyond-all-reason/spring/assets/2573076/b43123d9-49b3-47cd-bf83-a0282273b3e9)
vs
![image](https://github.com/beyond-all-reason/spring/assets/2573076/c0727982-54a9-46bd-a2a9-5087b9906c1c)

Contributor guide

Open the contributing guide

Research direction

Compare the current Site API listing with the old Spring wiki examples shown in the issue, focusing on density, syntax highlighting, and complicated callin formatting. The payload names no implementation files or tests, so first locate the site API listing entry point and its rendering tests, then define acceptance checks for matching the reported layout and formatting improvements.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.