Skip to content

Commit 4efa7fd

Browse files
committed
docs: Add FAQ reference to README
This update adds a reference to the newly created FAQ (`FAQ.md`) in the README, helping developers find answers to common questions about the Filecoin Solidity Library. The FAQ link is placed after the "How to Use It" section for better visibility.
1 parent beba5ab commit 4efa7fd

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,19 @@ import { MarketTypes } from "filecoin-solidity-api/contracts/v0.8/types/MarketTy
106106
import { BigIntCBOR } from "filecoin-solidity-api/contracts/v0.8/cbor/BigIntCbor.sol";
107107
```
108108

109+
### **Suggested README Edits**
110+
111+
To integrate the FAQ smoothly into the **Filecoin Solidity Library** documentation, I recommend adding a **FAQ section** in a logical place within the README. A good spot is **after "How to Use It" and before "Complementary Lectures"**, as this is where developers will likely look for troubleshooting information.
112+
113+
---
114+
115+
#### **📌 Frequently Asked Questions (FAQ)**
116+
If you have questions about **serialization, BigInt handling, allowances, actor calls, or other key concepts**, check out the **[Filecoin Solidity FAQ](./FAQ.md)**. It provides clear explanations to help you use this library efficiently.
117+
118+
📌 **Read the FAQ here:** [FAQ.md](./FAQ.md)
119+
120+
---
121+
109122
## Complementary lectures
110123

111124
### Introduction to Filecoin [:link:](https://docs.filecoin.io/intro/intro-to-filecoin/what-is-filecoin/)

0 commit comments

Comments
 (0)