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

Introduce dedicated documentation #3402

Closed

Conversation

renardeinside
Copy link
Contributor

@renardeinside renardeinside commented Dec 4, 2024

Introduces a full-scale documentation based on:

Docs structure is split into 4 sections:

User-facing:

  • Installation
  • Process (describes actual migration process)
  • Reference (describes commands and details)

Also, there is a separate dev docs section.

Some screenshots:

Landing page:
Screenshot 2024-12-10 at 18 10 57

Overview:
Screenshot 2024-12-10 at 18 11 19

Installation instructions:
Screenshot 2024-12-10 at 18 11 57

Search is built-in, as well as many other capabilities.

There are some unresolved problems however:

  1. Hugo doesn't have any link verification mechanism at all for fragment-based links (e.g. #some-fragment).
  2. We require a lot of custom code to simply render markdown-like links.
  3. Hextra theme doesn't have "zoom-on-click" functionality. We'll probably need to implement it.

@renardeinside renardeinside changed the title add landing page and minimal structure introduce dedicated documentation Dec 4, 2024
@renardeinside renardeinside changed the title introduce dedicated documentation Introduce dedicated documentation Dec 5, 2024
@renardeinside
Copy link
Contributor Author

closing this one in favor of #3458 due to framework change.

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.

1 participant