Task Description
Service Tasks
- The starting point of the guidelines is:
- https://splitcells.net/net/splitcells/network/guidelines/index.html
- http://localhost:8443/net/splitcells/network/guidelines/index.html
- Update the project's history page.
- [ ] Consolidate https://splitcells.net/net/splitcells/gel/history/index.html into https://splitcells.net/net/splitcells/network/history/index.html.
- Start of documentation: https://github.com/www-splitcells-net/net.splitcells.network
- Consider Documentation from point of a user
- Consider Documentation from point of a developer
- Consider Documentation from point of a product owner.
- Consider mobile vs desktop view.
Tasks
- [ ] Link to https://passo.uno/what-is-a-documentation-engineer/ in documentation guidelines as inspiration.
- [ ] Import theoretic formulas regarding assignment problem definition from personal master thesis.
- [ ] Make code viewer nice.
- [ ] Reduce background shadows for images, in order to reduce noise.
- [ ] Create/improve styling guidelines.
- [ ] Consider a paper shadow effect for chapter titles.
- [ ] Make hyperlinks in flowing text sans serif, in order to mark their limited interactivity.
- [ ] Create more whitespace in README in main list between the emojis and their respective text.
- [ ] On mobile view every content column should be separated more distinctly.
- [ ] On mobile view every content column, should have a complete menu bar.
See meta column for a negative example.
- [ ] Remove graphical noise from flowing text, like too strong, big or many shadows.
- [ ] Consider making a styling guideline, where this is noted.
- [ ] Consider creating a book out of the project's documentation.
- [ ] Create a short developer manifesto.
- [ ] Create a short documentation and writing manifesto.
- [ ] Every document in the Network Community should be linked by another document in Network project.
In other words, the Community documents should be considered to be part of the documentation.
- [ ] Consider creating a newsletter that bundles blog, social media posts and interesting info like releases of other optimization software, that contain something interesting regarding optimization.
- [ ] Add newsletter to global changelog.
- [ ] Note in programming guidelines, that implicit error handling is preferred to explicit one.
Done Tasks
- [x] Add padding to the left of lists, in order to avoid clipping.