https://github.com/wultra/docucheck

Tool for validating Wultra's documentation
https://github.com/wultra/docucheck

documentation documentation-generator documentation-tool swift

Last synced: about 1 year ago
JSON representation

Tool for validating Wultra's documentation

• Host: GitHub
• URL: https://github.com/wultra/docucheck
• Owner: wultra
• License: apache-2.0
• Created: 2019-02-08T14:27:09.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-07-25T00:31:23.000Z (almost 2 years ago)
• Last Synced: 2025-03-30T15:05:42.068Z (about 1 year ago)
• Topics: documentation, documentation-generator, documentation-tool, swift
• Language: Swift
• Homepage:
• Size: 716 KB
• Stars: 2
• Watchers: 4
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Documentation Tool

The `DocuCheck` is a command line tool, written in Swift, that collects and validates documentation written in [Markdown](https://guides.github.com/features/mastering-markdown/). The tool does following main tasks:

- Collects documentation from various remote sources (typically from a remote git repository).

- Copies all predefined folders containing documentation into one predefined folder.

- Validates all links pointing to another documents or to anchors in the documents.

- Patches all documents to be easily served on Wultra's [developers portal](https://developers.wultra.com).

The tool was developed for Wultra's internal purposes, so it's highly specialized for what we need for our documentation. If you're still interested, then please visit [DocuCheck's documentation](docs/Readme.md).

## License

All sources are licensed using Apache 2.0 license, you can use them with no restriction. If you are using this tool, please let us know. We will be happy to share and promote your project.

## Contact

If you need any assistance, do not hesitate to drop us a line at [hello@wultra.com](mailto:hello@wultra.com) or our official [wultra.com/discord](https://wultra.com/discord) channel.