Official Landing Page https://www.gnusocial.rocks/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

95 lines
4.3 KiB

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=0.86, maximum-scale=5.0, minimum-scale=0.86">
  6. <link rel="shortcut icon" href="/favicon.ico">
  7. <link rel="stylesheet" href="https://www.gnusocial.rocks//assets/css/reset.css">
  8. <link rel="stylesheet" href="https://www.gnusocial.rocks//assets/css/blog.css">
  9. <link rel='stylesheet' type='text/css' href="https://www.gnusocial.rocks//assets/fonts/opensans/opensans.css">
  10. </head><title>Milestone: Documentation and Tests Infrastructure - GNU social V3</title>
  11. </head><body>
  12. <header>
  13. <div class="home-menu menu menu-horizontal menu-fixed">
  14. <a class="menu-heading" href="https://gnusocial.rocks/">
  15. <img src="../assets/img/gnu-social-logo-invert.svg" alt="GNU social">
  16. <b>gnu</b>social
  17. </a>
  18. </div>
  19. <div class="sidebar">
  20. <ul class="menu-list">
  21. <li class="menu-item menu-selected"><a href="index.html" class="menu-link">Blog Index</a></li>
  22. <li class="menu-item"><a href="https://code.gnusocial.rocks/" class="menu-link">Repository</a></li>
  23. <li class="menu-item"><a href="https://coverage.gnusocial.rocks/" class="menu-link">Code Coverage</a></li>
  24. <li class="menu-item"><a href="https://docs.gnusocial.rocks/" class="menu-link">Documentation</a></li>
  25. <li class="menu-item"><a href="https://agile.gnusocial.rocks/" class="menu-link">Wiki</a></li>
  26. <li class="menu-item"><a href="https://kanban.undefinedhackers.net/?controller=BoardViewController&action=readonly&token=d2293e55cabae7cceff9fb496c651328195357d392b9e61a9f229ed6d463" class="menu-link">Roadmap</a></li>
  27. </ul>
  28. </div>
  29. </header>
  30. <div class="content-wrapper">
  31. <div class="content">
  32. </div></div></div>
  33. <div id="template-wrapper"><div class="template-unit">
  34. <!-- entry begin -->
  35. <h3><a class="ablack" href="milestone-documentation-and-tests-infrastructure.html">
  36. Milestone: Documentation and Tests Infrastructure
  37. </a></h3>
  38. <!-- bashblog_timestamp: #202108041337.42# -->
  39. <div class="subtitle">August 04, 2021 &mdash;
  40. GNU social development team
  41. </div>
  42. <!-- text begin -->
  43. <p><strong><a href="https://agile.gnusocial.rocks/doku.php?id=milestones:initial_test_documentation_infrastructure">>WIKI Milestone entry</a></strong></p>
  44. <p>GNU social now has its documentation available in
  45. <a href="https://docs.gnusocial.rocks/">https://docs.gnusocial.rocks/</a>. It features four
  46. different books. These are automatically generated from the <a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/docs">source</a> using <a href="https://rust-lang.github.io/mdBook/">mdBook</a>.</p>
  47. <blockquote>
  48. <p>Only the development book is in an elaborated state, the other books are
  49. holding for more ready code.</p>
  50. </blockquote>
  51. <p>And two of them are new:</p>
  52. <ul>
  53. <li>The <a href="https://docs.gnusocial.rocks/developer">Developer</a> is both intended to guide third-party plugin developers and to make it easier of contributing to the code.</li>
  54. <li>The <a href="https://docs.gnusocial.rocks/designer">Designer</a> is the most recent of the four and came from a necessity of keeping some standardization between templates and ensuring the same principles are kept in mind when designing new themes.</li>
  55. </ul>
  56. <p>And two of them are updates from existing documentation:</p>
  57. <ul>
  58. <li>The <a href="https://docs.gnusocial.rocks/user">User</a> one is adapted
  59. from the existing GNU social documentation for users that was provided in v2.</li>
  60. <li>The <a href="https://docs.gnusocial.rocks/administrator">Administrator</a> one is adapted
  61. from the "Unofficial GNU social docs" by Thomask who <a href="https://notabug.org/diogo/gnu-social/issues/246">asked us to make it official</a>.</li>
  62. </ul>
  63. <p>Together with the documentation we've introduced a
  64. <a href="https://agile.gnusocial.rocks/">wiki</a>. Its purpose is to walk-through decisions,
  65. convention, terminology. It's where we document the reasoning the development team went
  66. through before implementing more sophisticated functionalities.</p>
  67. <p>Finally, when the documentation doesn't explain, and to ensure the whole code
  68. is properly tested, we have the
  69. <a href="https://code.undefinedhackers.net/GNUsocial/gnu-social/src/branch/v3/tests">tests</a>. And the coverage is available <a href="https://coverage.gnusocial.rocks/">here</a>. At the time of writing the coverage has 98.76% code lines tested.</p>
  70. <!-- text end -->
  71. <!-- entry end -->
  72. </div>
  73. </div></div>
  74. </div>
  75. </div></body></html>