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

Wiki updates (Sidebar and Gallery) #2303

Merged
merged 5 commits into from
Mar 25, 2024

Conversation

AlvinSchiller
Copy link
Collaborator

@AlvinSchiller AlvinSchiller commented Mar 21, 2024

PR to introduce some wiki and corresponding v2 repo changes.

Wiki changes can be seen here https://github.com/AlvinSchiller/RPi-Jukebox-RFID/wiki and will be merged together (updated files are _Sidebar.md, GALLERY.md, Home.md and img/gallery/calendar)

Updates

  • Sidebar
    • Add main section links for versions 2 and 3 to the wiki sidebar
      • existing pages are moved to extendable details
    • Add "gallery" as seperate entry (make it more present)
    • Add branch links for v2 to readme
  • Update wiki gallery
    • Update descriptions and links
    • Move Calenders to wiki gallery and add pdf files
    • Duplicate latest calender as "latest-*.jpg"-file and link to it from main repo readme (making future updates simpler as only the wiki needs to be updated). Also update description to be generic.
    • Remove duplicate images (repo and wiki) and change links to wiki images
    • Add links to existing "design" tickets
    • Add video section from readme
  • Remove links to gitter from readme
  • Update description and links for matrix (aligned with description from the "new issue" section)

Sidebar

feature_updateWiki_Sidebar2 1 feature_updateWiki_Sidebar2 2

Gallery

feature_updateWiki_Gallery1

...

feature_updateWiki_Gallery2

@AlvinSchiller AlvinSchiller added documentation legacy_v2 Issues, discussions and PRs related to Version 2.x labels Mar 21, 2024
@AlvinSchiller AlvinSchiller added this to the v2.6 milestone Mar 21, 2024
@AlvinSchiller AlvinSchiller self-assigned this Mar 21, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 8368924447

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 78.435%

Totals Coverage Status
Change from base Build 8343711957: 0.0%
Covered Lines: 451
Relevant Lines: 575

💛 - Coveralls

@s-martin
Copy link
Collaborator

Do I understand it correctly that the future3 sidebar section are only links to the markdown docs in the repo?

@AlvinSchiller
Copy link
Collaborator Author

AlvinSchiller commented Mar 21, 2024

Do I understand it correctly that the future3 sidebar section are only links to the markdown docs in the repo?

Yep, the main documentation remains in the repo (will also try to move as much v2 docs as possible in upcoming changes).
User hacks, very specific manuals and howto's not bound to the code can still be added to the wiki by every user.

@AlvinSchiller
Copy link
Collaborator Author

Any addition /changes or good to go?

@s-martin
Copy link
Collaborator

Good to go

@AlvinSchiller AlvinSchiller merged commit d17f3fb into MiczFlor:develop Mar 25, 2024
10 checks passed
@AlvinSchiller AlvinSchiller deleted the docs/update_wiki branch March 25, 2024 07:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation legacy_v2 Issues, discussions and PRs related to Version 2.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants