Contributing to Lookyloo Documentation

You can contribute by:

Contributor Behavior

Examples of behavior that contributes to creating a positive environment include:

Get started by installing and getting familiar with Git.
Use AsciiDoc to contribute to Lookyloo documentation.
Refer to our style guide for guidance on formatting your documentation contributions.

Thank you for your contributions. To start contributing to Lookyloo:

Create an issue describing your proposed change to the repository.
The repository owners will triage and respond to your issue promptly.
Fork the repository.
Submit a pull request with the proposed changes. The required format for the Git commit message is "Issue # <Issue ID> - <issue_message>".

GitHub issues can be used to report bugs or submit feature requests.

When reporting an issue, you can use the issues template.

The documentation is written in the Asciidoc markup language and uses Antora.

The source documentation files are located in the modules/ROOT/pages/ directory in the Lookyloo documentation repository.

The following are required:

To update existing documentation:

Checkout the branch you want to update, for example:
```
git checkout main
```
Ensure that your forked repository is in sync with the selected upstream repository:
```
git fetch <lookyloo/docs>
```
```
git reset --hard <lookyloo/docs> main
```
Checkout a new feature branch with the <Issue #> as the name, for example:
```
git checkout -b Issue#123
```

Make changes to the documentation.

To add a new module to the repository, add the module to the /modules/ROOT/nav.adoc file in the following format:

* xref:<module_filename.adoc>[<module title>].

The number of asterisks (*) denotes the heading level.

To build a preview of the doc, run the command:

antora local-site.yml && <your_preferred_browser> build/site/index.html