95 lines
4.3 KiB

<!DOCTYPE html>
<html lang="en">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=0.86, maximum-scale=5.0, minimum-scale=0.86">
<link rel="shortcut icon" href="/favicon.ico">
<link rel="stylesheet" href="">
<link rel="stylesheet" href="">
<link rel='stylesheet' type='text/css' href="">
</head><title>Milestone: Documentation and Tests Infrastructure - GNU social V3</title>
<div class="home-menu menu menu-horizontal menu-fixed">
<a class="menu-heading" href="">
<img src="../assets/img/gnu-social-logo-invert.svg" alt="GNU social">
<div class="sidebar">
<ul class="menu-list">
<li class="menu-item menu-selected"><a href="index.html" class="menu-link">Blog Index</a></li>
<li class="menu-item"><a href="" class="menu-link">Repository</a></li>
<li class="menu-item"><a href="" class="menu-link">Code Coverage</a></li>
<li class="menu-item"><a href="" class="menu-link">Documentation</a></li>
<li class="menu-item"><a href="" class="menu-link">Wiki</a></li>
<li class="menu-item"><a href="" class="menu-link">Roadmap</a></li>
<div class="content-wrapper">
<div class="content">
<div id="template-wrapper"><div class="template-unit">
<!-- entry begin -->
<h3><a class="ablack" href="milestone-documentation-and-tests-infrastructure.html">
Milestone: Documentation and Tests Infrastructure
<!-- bashblog_timestamp: #202108041337.42# -->
<div class="subtitle">August 04, 2021 &mdash;
GNU social development team
<!-- text begin -->
<p><strong><a href="">>WIKI Milestone entry</a></strong></p>
<p>GNU social now has its documentation available in
<a href=""></a>. It features four
different books. These are automatically generated from the <a href="">source</a> using <a href="">mdBook</a>.</p>
<p>Only the development book is in an elaborated state, the other books are
holding for more ready code.</p>
<p>And two of them are new:</p>
<li>The <a href="">Developer</a> is both intended to guide third-party plugin developers and to make it easier of contributing to the code.</li>
<li>The <a href="">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>
<p>And two of them are updates from existing documentation:</p>
<li>The <a href="">User</a> one is adapted
from the existing GNU social documentation for users that was provided in v2.</li>
<li>The <a href="">Administrator</a> one is adapted
from the "Unofficial GNU social docs" by Thomask who <a href="">asked us to make it official</a>.</li>
<p>Together with the documentation we've introduced a
<a href="">wiki</a>. Its purpose is to walk-through decisions,
convention, terminology. It's where we document the reasoning the development team went
through before implementing more sophisticated functionalities.</p>
<p>Finally, when the documentation doesn't explain, and to ensure the whole code
is properly tested, we have the
<a href="">tests</a>. And the coverage is available <a href="">here</a>. At the time of writing the coverage has 98.76% code lines tested.</p>
<!-- text end -->
<!-- entry end -->