[Docs] Add “View Documentation” link to README and App Settings

Open
#1,078 0 comments 0 reactions 1 assignee View on GitHub

@zaelgohary is already working on this.

Since Dec 11, 2025.

Assessment

This issue has not been assessed yet.

Description

Is there an existing issue for this?
  • I have searched the existing issues
What happened?

Currently, the TFConnect user guide (https://manual.grid.tf/documentation/tfconnect/tfconnect_toc.html) is difficult to discover. There is no link in the repository’s README or in the TFConnect app itself that points users to the official documentation. As a result, new users (and even existing contributors) cannot easily find the manual, leading to confusion and support overhead.

Steps To Reproduce

Can we add the docs link to the
Repository README

  • Add a “Documentation” section (with a prominent hyperlink) in README.md that points to the hosted TFConnect manual.
  • placement: directly under the “Installation” or “Features” headings.

In-App Link

  • Add a “View Documentation” (or “Help & Docs”) button somewhere in the TFConnect UI (e.g., in the Settings menu or the “About” screen).
Relevant screenshots/screen records

Image

Relevant log output
.
Dominant language
Dart
Stars
9
Forks
5
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from threefoldtech/grid_connect

All issues in threefoldtech/grid_connect

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.