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

Create roadmap to move to MarkDown #51

Open
adikhoff opened this issue Oct 26, 2024 · 0 comments
Open

Create roadmap to move to MarkDown #51

adikhoff opened this issue Oct 26, 2024 · 0 comments

Comments

@adikhoff
Copy link
Collaborator

adikhoff commented Oct 26, 2024

Some considerations (growing list):

  • RST converstion. Tools already available? Or build something new?
  • Directory structure
  • How to render
  • Integration with redot-engine. Include XML to RST conversion?

From the engine team:

  • Current workflow is edit XMLs, autoconvert XMLs to RSTs, then RSTs get integrated in docs project
  • XML workflow cannot be abandoned because it's integrated throughout the engine and Q/A pipeline.

Considerations for a solution that would convert XML straight to MD:

  • Q/A pipeline in engine currently ensures that RSTs can get generated from XMLs. This is to ensure that the docs are sound and good. An alternative would be required for MDs.
  • There are hardcoded links in the engine that refer to the classic directory structure.
@adikhoff adikhoff converted this from a draft issue Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

1 participant