Maintain guidelines and documentation
  • Issue number: #54

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
  • 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

  • [ ] Work on inherently-broken-and-rotten-by-design.xml.
  • [ ] 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 About This Site more complete.
    • [ ] Master Thesis
    • [ ] After Master Thesis
    • [ ] Hetzner Deployment
  • [ ] 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.

Done Tasks

  • [x] Add padding to the left of lists, in order to avoid clipping.