engineervix / zm-ictaz

The Information and Communications Technology Association of Zambia Act, 2018 – powered by VitePress
https://ictaz-act.pages.dev
GNU Free Documentation License v1.3
0 stars 0 forks source link

The Information and Communications Technology Association of Zambia Act, 2018

An Act to establish the Information and Communications Technology Association of Zambia and provide for its functions; provide for the registration of information and communications technology professionals and regulate their professional conduct in the interest of the information and communications technology sector; and provide for matters connected with, or incidental to, the foregoing.

Source: https://www.parliament.gov.zm/node/7626

CI Node v22 code style: prettier

Conventional Commits

Introduction

Powered by VitePress, this project transforms a traditionally dense and difficult to navigate PDF of the aforementioned Act into an easily navigable, searchable, and visually appealing online resource.

Why this project exists

Navigating legislative documents can be daunting and often results in a headache. This project was born out of the desire to make the process of understanding the Act more approachable and less painful.

How the content was put together

This is the approach I took:

  1. Download the original pdf from the National Assembly of Zambia website.
  2. Use Adobe Acrobat Online PDF to Word Converter to convert the pdf to a docx file.
  3. Use pandoc to convert the docx file to Markdown (based on this gist):
pandoc \
  -t markdown_strict \
  --extract-media='./attachments/source' \
  source.docx \
  -o output.md
  1. Copy / paste the content, and clean up where the formatting is incorrect.

[!WARNING]
The formatting of the Pandoc-generated output was not 100% accurate. While I have made every effort to correct formatting issues and other minor bugs, you might encounter some typos, incorrect numbering, or potentially missing content.

If you notice any of these issues, please help in fixing them by opening an issue or submitting a pull request. Your contributions are greatly appreciated.

Gracias

Development

First things first

You need to have Node.js 22 installed on your machine. You can use tools such as nvm, volta, etc. to simplify managing Node.js versions on your machine.

Getting Started

Upon cloning this repository (or forking + cloning your fork), navigate to the cloned project directory.

  1. Install dependencies

    npm install
  2. Run the dev server

    npm start

    The documentation will be available at: http://localhost:5173

Contributing

This project follows the all-contributors specification. Contributions are most welcome! A good place to start is by helping out with the unchecked items in the TODO section of this README!

Feel free to check the issues page and take a look at the contributing guide before you get started.

TODO

Notice

I do not own the copyright to the contents of the aforementioned Act. The text of the Act is a public document, and this project aims to make it more accessible and user-friendly. Any modifications or enhancements to the presentation are my own work, and permission is granted to copy, distribute and/or modify this work under the terms of the GNU Free Documentation License as published by the Free Software Foundation, either version 1.3, or (at your option) any later version; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is contained in the file COPYING.