Skip to content
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.

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

Total Link overhaul + contribution Guide + Standardization of links + Fixes broken links. #42

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

ckartik
Copy link
Contributor

@ckartik ckartik commented Apr 4, 2024

  • Adds the following: contribution guide, with a standard for file names and link habits.
## mev-commit platform documentation


# Contribution Guidelines
Welcome to our documentation, we are glad to have you here!

This repository contains the source code for our documentation website. If you'd like to contribute, please follow these guidelines:

1. Fork the repository and create a new branch from the `main` branch.
2. Make your changes to the markdown files.
3. Submit a pull request to the `main` branch.

## Standards and conventions

### Links
- Ensure all links that reference the documentation are linking using an absolute path. For example, to reference fund node page, you do as follows: `[fund node](/get-started/bidders/fund-node)`.

### New Files
- Ensure all files are in lowercase.
- Ensure all files are using kebab-case. For example, the kebab-case version of "My First Preconf" is "my-first-preconf.mdx".

We'd appreciate if you would run mintlify dev to verify changes locally and mintlify broken-links to ensure there aren't any broken links introduced from your changes. Thank you! :) 


  • Removes node_modules that seemed to have been introduced.
  • Runs mintlify broken-links and fixes all broken links outside of non-active pages as follows:
krishchopra@krishs-mbp mev-commit-docs % mintlify broken-links
Checking for broken links...

Primev Docs Testnet Ver 41c24e77a73e47e0966d54365efbbfc8.md
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Untitled.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Untitled%201.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/System_Overview_-_b2.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Handshake.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/bootnode.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/mev_p2p.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/mev-supply-chain.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/oracle-detailed-overview.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Oracle-before.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/oracle.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Oracle_non_happy.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8.md
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8.md
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Contract_Architecture.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Untitled%202.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Bidder_Alloawnce.png
  Primev%20Docs%20Testnet%20Ver%2041c24e77a73e47e0966d54365efbbfc8/Provider_Allowance.png

development.mdx
  /changelog/command-line

knowledge-base/introduction.mdx
  what-is-prepay-amount
  how-do-i-fix-the-error-failed-to-read-msg-stream-reset
  what-is-foundry
  why-is-cast-necessary-for-mev-commit-chain-interactions
  why-do-i-receive-the-same-commitment-when-resending-a-bid

quickstart.mdx
  /settings/global
  /api-playground/configuration
  /analytics/supported-integrations
  /settings/custom-domain/subdomain

27 broken links found.

Note these are not broken links but false positives.

@@ -71,5 +71,5 @@ Users can open an issue on the GitHub repository that is associated with any iss

## Testnet System Requirements

Please refer to the System Requirements section [here.](https://docs.primev.xyz/developers/system-requirements)
Please refer to the System Requirements section [here.]/developers/system-requirements)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems there's more places we need the opening parenthesis

Suggested change
Please refer to the System Requirements section [here.]/developers/system-requirements)
Please refer to the System Requirements section [here.](/developers/system-requirements)

Copy link
Contributor

@shaspitz shaspitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ckartik this PR hasn't been fixed elsewhere correct? If so I can rebase and review

@Dogandi
Copy link
Collaborator

Dogandi commented Jun 5, 2024

@ckartik I think most of this is deprecated but if you want to change the readme file we can do that. What do you think?

@shaspitz shaspitz marked this pull request as draft August 14, 2024 22:07
@shaspitz
Copy link
Contributor

Set as draft until its more clear whether this is needed or not

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.

3 participants