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

Discussion: the path forward #5

Open
plowsof opened this issue Jul 27, 2024 · 3 comments
Open

Discussion: the path forward #5

plowsof opened this issue Jul 27, 2024 · 3 comments

Comments

@plowsof
Copy link
Collaborator

plowsof commented Jul 27, 2024

i assume this will be put into #1

these seem to be our options:

  • starting with Just the docs + monerodocs original files. for reference, monero-docs master branch looks like https://md.monerodevs.org/
  • update the original monerodocs front/backend to their latest versions : for reference: https://md.monerodevs.org/ is a preview of https://github.com/plowsof/md/tree/latest_mkdocs_test
    • the original monerodocs has calls to googleapi's for fonts, this is not the case with the updated version that uses the privacy plugin
    • git-committers plugin to display contributors at the bottom / and also last revision date (compatible with localisation) e.g. this cryptography related page. We can accept contribs from anyone * or commit external contribs using appropriate author name * e.g. MAGIC can submit PR's under a specific account

all of the above is flexible / not been decided on*

@jermanuts
Copy link

https://getmonero.dev/ is more up-to-date docs

@nahuhh
Copy link
Collaborator

nahuhh commented Jul 27, 2024

.dev has some updates to it, but also some unnecessary (imo) changes. Its adapted for justthedocs, which has issues with no-js

@dan-is-not-the-man
Copy link
Collaborator

I would stick to mkdocs material as it has better plugins and is designed for documentation. As ofrn said no js breaks the drop down menus for justfordocs and also majority of the work has been done already. Also i'm not sure it has localization. With mkdocs material there is plugins:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Completed
Development

No branches or pull requests

4 participants