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

Remove coverpage to allow long sidebar #243

Merged
merged 5 commits into from
Mar 8, 2023
Merged

Remove coverpage to allow long sidebar #243

merged 5 commits into from
Mar 8, 2023

Conversation

jbsv
Copy link
Contributor

@jbsv jbsv commented Jan 30, 2023

Related to #236, here is an attempt to improve browsing the DELA doc page.

@jbsv jbsv requested a review from pierluca January 30, 2023 15:36
@coveralls
Copy link

coveralls commented Jan 30, 2023

Pull Request Test Coverage Report for Build 4105461650

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 99.283%

Totals Coverage Status
Change from base Build 4017041211: 0.0%
Covered Lines: 14260
Relevant Lines: 14363

💛 - Coveralls

@pierluca
Copy link
Contributor

pierluca commented Feb 6, 2023

@jbsv how can I see the output ? 😅

@jbsv jbsv self-assigned this Feb 6, 2023
@sonarcloud
Copy link

sonarcloud bot commented Feb 6, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@jbsv
Copy link
Contributor Author

jbsv commented Feb 7, 2023

@pierluca, from your local git copy of dela: docsify serve docs, which implies that you install docsify-cli on your machine

@@ -1064,8 +1064,6 @@ func getCertified(t *testing.T) (*pedersen.DistKeyGenerator, *pedersen.Response)
}

type fakeDKGService struct {
dkgService
Copy link
Contributor

Choose a reason for hiding this comment

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

are you sure about this in this PR ? 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes

@pierluca
Copy link
Contributor

pierluca commented Feb 7, 2023

Okay, I've been able to run it. Thanks for the instructions.

Couple of points of feedback:

  1. "General Purpose", "Code" and "Instructions" in the menu seem to be not clickable ? It's a bit unclear.
    If they're supposed to be headers, some vertical spacing might be helpful, but I'm not sure they're very helpful.
    If we just rename "Guideline" into "Code Guideline", the rest is self-explanatory.

EDIT: I just checked the original, and this change seems to make the navigation bar way uglier overalls.
I understand better the headers now.

  1. The home page would stand to benefit from having the introduction text featured more prominently and the image way smaller, as right now (on my screen, at least) the home page provides 0 useful content and just one BIIIIIIIIG picture 😅

EDIT: It's also not clear why "introduction" and "Dela" would be separate pages, as the introduction is basically pointless to someone browsing the documentation, without going into "Dela".

  1. The code guidelines might need (slight) updating if you want to drop the mod.go guideline.

@pierluca pierluca merged commit 410b1be into master Mar 8, 2023
@pierluca pierluca deleted the docs branch March 8, 2023 13:42
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.

None yet

3 participants