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

xt-docs template changes #62

Closed
nkrusch opened this issue Jun 12, 2021 · 0 comments · Fixed by #63
Closed

xt-docs template changes #62

nkrusch opened this issue Jun 12, 2021 · 0 comments · Fixed by #63
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request
Milestone

Comments

@nkrusch
Copy link
Contributor

nkrusch commented Jun 12, 2021

xt-docs command builds documentation site for an extension project using JSDoc3, which is quite useful for documentation purposes. The current default configuration uses a template called foodoc. But foodoc source is not being maintained, uses old packages, etc. so it is time to switch to something else.

Possible options (I would say in order of preference):

  • find a different template that is being maintained
  • fork foodoc template and start maintaining it
  • make a new template
  • default to default / no template

(I'm not able to find many that are being maintained) but here are some candidates:

Should also update the user guide and list all these options on there. A project can use any template they want. This issue is about choosing the default template.

EDIT: After trying some of these templates, not sure about using them. I am now thinking: set default to default in this project. Then fork foodocs and modify it (a lot) to update dependencies and the dated bootstrap style at which point is becomes a new-ish template. Add to the user guide a list of templates to use. So this is a mix of the last 3 options.

@nkrusch nkrusch changed the title xt-docs xt-docs template changes Jun 12, 2021
nkrusch added a commit that referenced this issue Jun 26, 2021
#62 - xt-docs: change default template and explain alternatives
@nkrusch nkrusch added this to the 1.2.0 milestone Jun 26, 2021
@nkrusch nkrusch added dependencies Pull requests that update a dependency file enhancement New feature or request labels Jul 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file enhancement New feature or request
Development

Successfully merging a pull request may close this issue.

1 participant