pactus-project / docs

Pactus Blockchain Documentation

Pactus Documentation

This repository contains all the content for the https://docs.pactus.org website.

Contributing to Documentation

Contributions to the website, including fixing typos or grammatical errors, are always welcome. To contribute, simply edit the relevant page or open a pull request.

Running Locally

To get started, install Hugo, first. Now, clone this repository and run it locally using the following commands:

git clone https://github.com/pactus-project/docs.git
cd docs
hugo server

Markdown

Markdown is a lightweight markup language that uses plain text formatting syntax to convert text into HTML, making it easy to read and write for web content.

Linting

Markdown linting helps ensure consistent style and formatting, detects syntax errors, improves readability, and maintains best practices in Markdown documents.

To lint Markdown files, you can use the mdl (MarkdownLint) command-line tool. This tool checks your Markdown files against a set of rules and provides feedback on any issues found.

To install mdl, first you need to install Ruby. Once you ensure Ruby installed on your system, you can install mdl by running:

gem install mdl

Then you can lint your Markdown files with the following command:

mdl --style=.mdlrc.rb ./content

This command will check all documents in the content folder for any linting issues and output them in the terminal.

Deployment

Updating the main branch will automatically deploy this repository through deploy Github action.

docs's Issues

Some TODOs

Some TODOs:

1- Rename "Pactus Blockchain documentation" to "Pactus Documentation"
2- Remove "📑 Documentation" link. It is redundant
3- "Get Started" needs to be in center and have margin
4- Add "Learn More" with different color next to "Get Started" and links to https://docs.pactus.org/docs/concepts/

Removing Android documentation

Running Pactus on Android devices is not recommended.

It's better we remove Android support from both Download and Documentation as well as releaser.

faveIcons are missed

The favicons.html is not valid.

Check Favicon checker to make sure FaveIcons are set properly. as an example look here

Removing configuration help

The configuration file in Pactus includes inline documentation and changes over time.
As the config file changes during development, it becomes challenging to keep the documentation synchronized with the latest changes.
I suggest removing the configuration file documentation from the website.

mathjax.html is all commented

the mathjax.html is all commented and can be removed.

Terminology page

Utilize pngquant for image (png) optimization

Utilize pngquant for the image optimization. Please check pactus.org repository for how to do it at here.

Unnecessary files in repo

Some files don't seem necessary to include in the repo, such as hugo_stats.json, .hugo_build.lock

GoogleAnalytics is deprecated

WARN deprecated: .Site.GoogleAnalytics was deprecated in Hugo v0.120.0 and will be removed in a future release. Use .Site.Config.Services.GoogleAnalytics.ID instead.