Documentation #29
Documentation #29
Conversation
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ ❗ Your organization needs to install the Codecov GitHub app to enable full functionality. 🚀 New features to boost your workflow:
|
Vybornak2
left a comment
Vybornak2
left a comment
There was a problem hiding this comment.
Format looks good overall.
Most of all I would suggest removal of buttons at places where simple links can be used since these buttons do not really fit into the page layout.
|
We should also look into customizing Admonitions (mainly colour). |
Vybornak2
left a comment
Vybornak2
left a comment
There was a problem hiding this comment.
Remove pie emoji
Move license to home page (navigation)
Remove tip from contacts
Adjust admonitions
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation across multiple files to improve navigation, content structure, and user experience, addressing issue #26. The changes focus on enhancing the visual presentation with icons, reorganizing navigation, and adding a new contact page.
Key changes include:
- Updated MkDocs theme icons for better visual consistency
- Added new contact page and reorganized navigation structure
- Enhanced documentation formatting with icons, tabs, and improved layouts across development guides
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
mkdocs.yml |
Updated theme icons and navigation structure, moved license page location |
docs/index.md |
Enhanced homepage with icons, improved formatting, and restructured sections |
docs/faber_cost.md |
Added comprehensive FABER project information with leadership contacts |
docs/development/testing.md |
Improved formatting with icons, better structure, and enhanced readability |
docs/development/install.md |
Added icons, improved installation instructions with multiple options |
docs/development/index.md |
Restructured development guide with better organization and visual elements |
docs/development/documentation.md |
Significantly expanded with naming conventions, mathematical notation guide |
docs/development/code_style.md |
Enhanced formatting and reorganized content with better visual structure |
docs/development/ci_cd.md |
Improved readability with icons and better section organization |
docs/contact.md |
New contact page with team information and collaboration channels |
CONTRIBUTING.md |
Enhanced with better formatting, icons, and improved structure |
CODE_OF_CONDUCT.md |
Minor formatting fix for email address |
Comments suppressed due to low confidence (1)
docs/development/install.md:136
- The environment activation command uses placeholder text '{environment_name}' which should be replaced with actual instructions or a more generic example like 'venv' or '.venv'.
pytest -xvs
|
|
||
| Action Chair & Grant Holder Scientific Representative | ||
|
|
||
| [:fontawesome-brands-linkedin: Contact](#)     [:material-email: Contact 2](#) |
There was a problem hiding this comment.
The contact links are placeholders with empty anchor tags (#). This creates non-functional links that could confuse users trying to contact the leadership team.
| [:fontawesome-brands-linkedin: Contact](#)     [:material-email: Contact 2](#) | |
| [:fontawesome-brands-linkedin: Contact](https://www.linkedin.com/in/jan-papuga/)     [:material-email: Contact 2](mailto:jan.papuga@example.com) |
| Action Vice-Chair | ||
| <br> | ||
|
|
||
| [:fontawesome-brands-linkedin: Contact](#)     [:material-email: Contact 2](#) |
There was a problem hiding this comment.
The contact links are placeholders with empty anchor tags (#). This creates non-functional links that could confuse users trying to contact the leadership team.
| [:fontawesome-brands-linkedin: Contact](#)     [:material-email: Contact 2](#) | |
| [:fontawesome-brands-linkedin: LinkedIn Profile](https://www.linkedin.com/in/charalampos-baniotopoulos)     [:material-email: Email](mailto:charalampos.baniotopoulos@example.com) |
|
|
||
| ```bash | ||
| # Activate project environment | ||
| .\{environment_name}\Scripts\activate |
There was a problem hiding this comment.
The environment activation command uses placeholder text '{environment_name}' which should be replaced with actual instructions or a more generic example like 'venv' or '.venv'.
| .\{environment_name}\Scripts\activate | |
| .\venv\Scripts\activate |
|
|
||
| ```bash | ||
| # Activate project environment | ||
| .\{environment_name}\Scripts\activate |
There was a problem hiding this comment.
The environment activation command uses placeholder text '{environment_name}' which should be replaced with actual instructions or a more generic example like 'venv' or '.venv'.
| .\{environment_name}\Scripts\activate | |
| .\venv\Scripts\activate |
3 participants
Updated documentation with respect to issue #26
Note:
Not updated project structure description in Development Overview.
Contact links need actual links, for now should be treated as placeholders.