Skip to content

Include user docs in readme & settings page #1179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zaelgohary wants to merge 2 commits into
base: development
Choose a base branch
from
Open

Include user docs in readme & settings page #1179

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8df6663
Include user docs in readme & settings page
zaelgohary Dec 11, 2025
746b787
Update app/lib/screens/preference_screen.dart
zaelgohary Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

Threefold Connect is a mobile app that serves as your main gateway to the Threefold Grid and various other Threefold products and services.

## Documentation

For detailed user documentation and guides, please visit the [TFConnect User Guide](https://manual.grid.tf/labs/documentation/tfconnect_toc).

## App

## Local development
Expand Down
14 changes: 14 additions & 0 deletions app/lib/screens/preference_screen.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@ class _PreferenceScreenState extends ConsumerState<PreferenceScreen> {
title: const Text('Terms and conditions'),
onTap: () async => {await _showTermsAndConds()},
),
ListTile(
leading: const Icon(Icons.help_outline),
title: const Text('View Documentation'),
Comment thread
zaelgohary marked this conversation as resolved.
Outdated
onTap: () async => {await _showDocumentation()},
),
ListTile(
leading: const Icon(Icons.logout_outlined),
title: Text(
Expand Down Expand Up @@ -459,6 +464,15 @@ class _PreferenceScreenState extends ConsumerState<PreferenceScreen> {
await launchUrl(Uri.parse(url));
}

Future<void> _showDocumentation() async {
const String url = 'https://manual.grid.tf/labs/documentation/tfconnect_toc';

final Uri uri = Uri.parse(url);
if (await canLaunchUrl(uri)) {
await launchUrl(uri, mode: LaunchMode.externalApplication);
}
}

void _showVersionInfo() {
try {
AppConfig appConfig = AppConfig();
Expand Down