Skip to content

WIKI_STRUCTURE

admin edited this page Jun 29, 2026 · 1 revision

Wiki structure guide

How to publish and maintain the medbiophys-app GitHub Wiki from docs/wiki/.


Publishing

GitHub wikis use a separate repository:

https://github.com/GKulesza/medbiophys-app.wiki.git
git clone https://github.com/GKulesza/medbiophys-app.wiki.git
cd medbiophys-app.wiki
cp /path/to/MedBioPhys/docs/wiki/*.md .
git add .
git commit -m "Update MedBioPhys wiki"
git push origin master

Home.md is the wiki front page. Filenames with hyphens become page titles (for example About-MedBioPhys.mdAbout-MedBioPhys).


First page

Setting Value
Front page Home.md
Purpose Download links (coming soon), one-paragraph intro, documentation navigation

Home answers: What is MedBioPhys? · Where will I download it? · Where is documentation?


Recommended sidebar

GitHub lists pages alphabetically. Optional _Sidebar.md:

### MedBioPhys

[[Home]]

**Using the app**
- [[Installation]]
- [[Frequently-Asked-Questions]]
- [[Known-Issues]]
- [[Release-Notes]]

**Information**
- [[About-MedBioPhys]]
- [[Privacy-Policy]]
- [[Support]]
- [[Roadmap]]
- [[Acknowledgements]]

**Contributors**
- [[For-Lecturers]]
- [[Open-Source-Licenses]]

Page hierarchy

Home
├── About-MedBioPhys
├── Installation
│   └── Frequently-Asked-Questions
├── Support
├── Privacy-Policy
├── Release-Notes
├── Known-Issues
├── Roadmap
├── Acknowledgements
├── For-Lecturers
└── Open-Source-Licenses
Audience Primary pages
Students Home, Installation, FAQ, Support, Known Issues
Stores / legal Privacy Policy, Release Notes, Open Source Licenses
UMB staff For Lecturers, Support
Maintainers Roadmap, Release Notes, For Lecturers

Cross-linking

Use wiki links:

[[Home]]
[[About-MedBioPhys|About MedBioPhys]]

Each page includes a breadcrumb line back to Home. Markdown only — no HTML or badges.


Page inventory

File Wiki page
Home.md Home
About-MedBioPhys.md About-MedBioPhys
Installation.md Installation
Privacy-Policy.md Privacy-Policy
Support.md Support
Frequently-Asked-Questions.md Frequently-Asked-Questions
Release-Notes.md Release-Notes
Known-Issues.md Known-Issues
Roadmap.md Roadmap
Acknowledgements.md Acknowledgements
For-Lecturers.md For-Lecturers
Open-Source-Licenses.md Open-Source-Licenses

Maintenance

Event Update
New release Release-Notes.md, version on Home.md
Store goes live Home.md, Installation.md — replace "coming soon" with store URLs
New known issue Known-Issues.md
Privacy change Privacy-Policy.md
New dependency Open-Source-Licenses.md

Align version numbers with PROJECT_STATUS.md in the application repository.


Future pages (when needed)

Page When
Contributing Public pull-request guidelines published
Accessibility Formal audit results available
Security Coordinated disclosure policy required
Changelog Release cadence exceeds manual Release Notes

Do not create empty stubs early.


What not to include

  • Internal phase reports or migration notes
  • Keystore or signing instructions (maintainer docs only)
  • Unreleased features
  • HTML embeds or status badges

Source of truth

Wiki content describes MedBioPhys 1.0.0 (build 59). Application repo: medbiophys-app. Content repo: medbiophys-content.

Editorial polish report: docs/release/WIKI_POLISH_REPORT.md.

Clone this wiki locally