Cantis

Cantis is a living documentation glossary extractor. It helps to keep your glossary up-to-date by extracting it from the documentation in your code.

Why

Cantis was created to overcome miscommunication about the meaning of domain-specific terms between co-workers (e.g. developers, managers, sales, customer heroes and so on).

It also may give developers an extra nudge to document classes with care.

Lastly, Elegant Object Principles are applied, to learn more about "true" Object-Oriented Programming and how Functional Programming can complement OOP. Hopefully this can lead to meaningful discussions about its applications.

Example

Currently, the Cantis from-java extractor is the heart of Cantis. It can extract a glossary from your Java codebase.

Consider a Java class:

/**
 * A person that uses our software.
 */
@Term
class User {

}

From-java can turn it into a glossary:

User: A person that uses our software.

Cantis from-java also generates its own glossary and cantisfile.json (a json formatted glossary).

Install and usage

Take a look at the README of the from-java extractor.

Cantisfile

Cantis is being rebuild to become a set of tools build around the cantisfile.

Cantisfiles contain everything that make-up a glossary. Its schema actually describes of what glossaries look like.

// Typescript definition of a cantisfile
interface Cantisfile {
    definitions: Definition[]
};
interface Definition {
    term: string
    description: string
};

How to contribute?

Just fork the repo and send us a pull request. If you have any questions, simply create an issue so we can talk about it.

Code of Conduct All contributions must adhere to the code of conduct, which shouldn't be hard. Just be nice.

License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

korthout / Cantis

readme