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

[ADP-3072] switch documentation rendering tool from emanote to mdbook #4006

Merged
merged 5 commits into from
Jul 1, 2023

Conversation

paolino
Copy link
Collaborator

@paolino paolino commented Jun 27, 2023

  • convert format of docs to mdbook
  • fix internal links
  • fix link to cardano-foundation/cardano-wallet
  • not fix external 404 links
  • copy over content from adrestia website links
  • copy a pdf from there as well

ADP-3072

@Unisay Unisay force-pushed the yura/ADP-2956/ghc928node811 branch from cec0d1f to b3c9299 Compare June 29, 2023 07:31
Base automatically changed from yura/ADP-2956/ghc928node811 to master June 29, 2023 08:36
@paolino paolino force-pushed the paolino/ADP-3072/switch-from-emanote-to-mdbook branch 3 times, most recently from 821949c to 41847c1 Compare June 29, 2023 11:24
@paolino paolino self-assigned this Jun 29, 2023
@paolino paolino force-pushed the paolino/ADP-3072/switch-from-emanote-to-mdbook branch 4 times, most recently from db2e800 to 140e223 Compare June 29, 2023 16:42
@paolino paolino force-pushed the paolino/ADP-3072/switch-from-emanote-to-mdbook branch from bb0f232 to 3eae4be Compare June 30, 2023 14:24
@paolino paolino marked this pull request as ready for review June 30, 2023 14:28
@paolino paolino force-pushed the paolino/ADP-3072/switch-from-emanote-to-mdbook branch 3 times, most recently from a9c5a33 to d84b0c7 Compare June 30, 2023 16:42
@paolino paolino force-pushed the paolino/ADP-3072/switch-from-emanote-to-mdbook branch from d84b0c7 to 6de2cff Compare June 30, 2023 16:47
@paolino paolino merged commit f0d8b0f into master Jul 1, 2023
@paolino paolino deleted the paolino/ADP-3072/switch-from-emanote-to-mdbook branch July 1, 2023 11:27
WilliamKingNoel-Bot pushed a commit that referenced this pull request Jul 1, 2023
…/switch-from-emanote-to-mdbook [ADP-3072] switch documentation rendering tool from emanote to mdbook Source commit: f0d8b0f
@srid
Copy link
Contributor

srid commented Jan 24, 2024

Interesting. Is there a particular set of features Emanote could have supported to obviate this change?

@HeinrichApfelmus
Copy link
Contributor

Interesting. Is there a particular set of features Emanote could have supported to obviate this change?

The main reason for switching was actually that I find the default mdbook theme to be visually more appealing:

  • The theme reserves almost all space for the text (e.g. hides by the navigation bar by default), making the text easier to read.
  • The navigation bar is more clear, with section numbers and better scrolling behavior.

That's about it, usability of the executable or configuration did not really factor into the decision. 🤔

@srid
Copy link
Contributor

srid commented Jan 25, 2024

Okay, cool. So that provides some usefulness to doing srid/emanote#505 especially as another person also asked for it.

@HeinrichApfelmus
Copy link
Contributor

Okay, cool. So that provides some usefulness to doing srid/emanote#505 especially as another person also asked for it.

Absolutely. 👍 To me, the visuals of the generated output are much more important than the method to generate them.

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.

4 participants