FuelLabs / FuelLabs/docs-hub

Code in context button

Open
#234 0 comments 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
124
Forks
78
Avg merge
22h 9m
Merged PRs (30d)
6

Description

Related to issue: https://github.com/FuelLabs/fuels-ts/issues/1960

## Summary

The `fuels-ts` documentation has a "Code in context button" which takes the user to the related code in GitHub.

image

[Source](https://fuellabs.github.io/fuels-ts/guide/contracts/)

The code in context link within the `fuels-ts` docs takes up a lot of real estate. Potential a button within the snippet would be better (terrible mock up below).

![code-in-context-button](https://github.com/FuelLabs/docs-hub/assets/16990131/57fbe99f-dba2-4dac-93e2-75dd94bc883d)

It's be good to have similar functionality within the Docs Hub, as it allows users to dive deeper.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the related fuels-ts issue 1960 and the linked contracts documentation page to understand the existing Code in context behavior. Then locate the Docs Hub implementation of code snippets or context links; done means the link is presented as a compact button without losing its functionality and is available in the Docs Hub.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.