Skip to content

Docs update: clarity, structure, and content improvements#56

Open
kuzdogan wants to merge 11 commits intomainfrom
update-docs-2
Open

Docs update: clarity, structure, and content improvements#56
kuzdogan wants to merge 11 commits intomainfrom
update-docs-2

Conversation

@kuzdogan
Copy link
Member

@kuzdogan kuzdogan commented Mar 4, 2026

Closes argotorg/sourcify#2589

Summary

  • API docs: Rewrote intro to clearly describe the two APIs (Server and 4byte); added LLM-friendly OpenAPI spec links; improved verification flow description; updated repo UI link to use a concrete example URL.
  • Contract dataset: Reordered sidebar (Download dataset now first); updated "continuously" → "regularly" for export frequency; bolded key links in Repo UI and Signatures database pages; reduced caption font sizes in Repo UI; restructured Signatures database to lead with API/Playground links.
  • BigQuery: Added example Colab Notebook link.
  • Verification docs: Added blog posts and talks section to "What is source code verification"; bolded verify.sourcify.dev link in Verify via UI.
  • Exact/Partial match: Collapsed previous terminology info box into inline notes; updated Exact Match description to mention Vyper fingerprints; removed Etherscan comparison paragraph from Matches section.
  • Transformations: Updated repo URLs to new format (/chainId/address instead of /contracts/match_type/chainId/address).
  • Monitoring service: Removed "Which chains do we monitor?" section.
  • CI report: Simplified chain test result link text.

TODOs

  • Update Hardhat and Foundry verification pages to their newest releases
  • Update Hardhat and Foundry sections inside the "Solidity metadata" page

kuzdogan added 9 commits March 4, 2026 14:49
…ontract data viewing link format. Adjust CI report message for clarity.
…ting

- Emphasize the repository UI access link by bolding it.
- Adjust font sizes for section titles in the repository UI documentation for consistency.
- Reorganize the signatures database section to highlight API and Playground links more prominently while maintaining the schema and download information.
- Split long paragraphs for better readability.
- Emphasize the distinction between verification and contract safety.
- Add links to relevant blog posts and talks on source code verification.
- Bold the verification UI link for better visibility.
- Update terminology for match types to reduce confusion, clarifying "Exact Matches" and "Matches" with previous names for context.
- Remove redundant info box regarding previous terminology to streamline content.
…rity

- Remove outdated sections from the monitoring service documentation to streamline content.
- Update library and immutable variable examples with correct links for better accessibility.
- Enhance overall readability and consistency across documentation sections.
…bytecode examples

- Replace Görli contract reference with Sepolia contract for accuracy.
- Update bytecode examples to reflect the correct immutable variable values.
- Enhance clarity in the explanation of bytecode modifications during contract deployment.
…inked libraries

- Replace outdated Görli and Rinkeby examples with new Optimism and Base contract references.
- Clarify the section title to emphasize the focus on manually linked libraries.
@netlify
Copy link

netlify bot commented Mar 4, 2026

Deploy Preview for sourcify-docs ready!

Name Link
🔨 Latest commit bd2a261
🔍 Latest deploy log https://app.netlify.com/projects/sourcify-docs/deploys/69a92054c5605800086f39fd
😎 Deploy Preview https://deploy-preview-56--sourcify-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kuzdogan kuzdogan moved this to Sprint - In Progress in Sourcify Public Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Clean up outdated information

2 participants