Project

General

Profile

Actions

User story #9018

closed

Improve ncf documentation

Added by Alexis Mousset about 8 years ago. Updated over 1 year ago.

Status:
Rejected
Priority:
N/A
Assignee:
-
Category:
Documentation
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

We would take advantage of:

  • Separate documentation files for long docs, using markdown syntax. It allows easy coloration and live render in text editors.
  • Document the documentation of techniques/generic methods
  • Documentation for all parts, not only generic methods and techniques. All parts of ncf API should be documented and available in Web pages.
Actions

Also available in: Atom PDF