Skip to content

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

@khaledyoussef24

Description

@khaledyoussef24

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

.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions