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.

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

Fix READ.me #3168

Merged
merged 1 commit into from
Sep 22, 2024
Merged

Fix READ.me #3168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ root
│ ├── <a href="./packages/coverage-aggregator">coverage-aggregator</a>: Javascript coverage aggregator based on <a href="https://www.npmjs.com/package/nyc">nyc</a>
│ ├── <a href="./packages/docs">docs</a>: Docasaurus documentation. Note: this is not yet in use, and docs are still maintained on gitbook
│ ├── <a href="./packages/explorer-ui">explorer-ui</a>: Explorer UI
│ ├── <a href="./packages/rfq-indexer">rfq-indexer</a>: RFQ indexer
│ ├── <a href="./packages/rest-api">rest-api</a>: Rest API
│ ├── <a href="./packages/sdk-router">sdk-router</a>: SDK router
│ ├── <a href="./packages/solidity-devops">solidity-devops</a>: provides a set of tools and scripts to help with the development of Solidity smart contracts
Expand Down
23 changes: 12 additions & 11 deletions packages/rfq-indexer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ The RFQ (Request for Quote) Indexer is a system designed to index and track brid
- API: Used by front-end applications, other services, or developers to query the indexed data.

## Directory Structure
rfq-indexer/
├── api/ # API service
│ ├── src/ # API source code
│ ├── package.json # API dependencies and scripts
│ └── README.md # API documentation
├── indexer/ # Indexer service
│ ├── src/ # Indexer source code
│ ├── abis/ # Contract ABIs
│ ├── package.json # Indexer dependencies and scripts
│ └── README.md # Indexer documentation
└── README.md # This file
<pre>
rfq-indexer
├── <a href="./api">api</a>: API service
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

Broken Anchor Links in README.md

The api and indexer directories referenced in the anchor links do not exist at the expected locations. Please ensure these directories are created or update the links accordingly to prevent navigation issues in Markdown renderers.

  • File: packages/rfq-indexer/README.md
    • Line 17: <a href="./api">api</a>
Analysis chain

Anchor links improve navigation but may have compatibility issues

The addition of anchor links for the api and indexer directories is a good improvement for navigation. However, be aware that these links might not work as expected in all Markdown renderers.

To ensure the links are correct, please run the following script:

Also applies to: 21-21

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify that the linked directories exist

# Check if the 'api' directory exists
if [ ! -d "./api" ]; then
  echo "Warning: The 'api' directory does not exist at the expected location."
fi

# Check if the 'indexer' directory exists
if [ ! -d "./indexer" ]; then
  echo "Warning: The 'indexer' directory does not exist at the expected location."
fi

Length of output: 367

│ ├── src/ : API source code
│ ├── package.json : API dependencies and scripts
│ ├── README.md : API documentation
├── <a href="./indexer">indexer</a>: Indexer service
│ ├── src/ : Indexer source code
│ ├── abis/ : Contract ABIs
│ ├── package.json : Indexer dependencies and scripts
│ ├── README.md : Indexer documentation
</pre>
Comment on lines +15 to +26
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider using Markdown syntax instead of HTML

While the use of HTML <pre> tag and anchor links improves the visual presentation and potential interactivity of the directory structure, it's generally recommended to use Markdown syntax in README files for better compatibility across different Markdown renderers.

Consider using the following Markdown syntax instead:

## Directory Structure

rfq-indexer
├── api: API service
│ ├── src/ : API source code
│ ├── package.json : API dependencies and scripts
│ ├── README.md : API documentation
├── indexer: Indexer service
│ ├── src/ : Indexer source code
│ ├── abis/ : Contract ABIs
│ ├── package.json : Indexer dependencies and scripts
│ ├── README.md : Indexer documentation


This approach maintains the improved structure while ensuring better compatibility.

<!-- This is an auto-generated comment by CodeRabbit -->

Loading