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

Update Stylesheets make doc documentation #705

Open
ebeshero opened this issue Oct 28, 2024 · 0 comments
Open

Update Stylesheets make doc documentation #705

ebeshero opened this issue Oct 28, 2024 · 0 comments

Comments

@ebeshero
Copy link
Member

ebeshero commented Oct 28, 2024

The Stylesheets README includes guidance on building Documentation for this repo by directoring the visitor to enter make doc, and outputting the built document at release/xslcommon/doc/tei-xsl/index.html. The built materials in xslcommon include guidance on how work with Stylesheets on conversions and a "Stylebear" tool (a web form that would let you input parameters to change, and generates a customized XSLT stylesheet), but that mechanism no longer works. (I don't know if I've ever seen the "Stylebear" in action.)

I'm opening this ticket to suggest we update / remove / fix this and other outdated documentation of the Stylesheets. We could remove the documentation entirely, but much of the information is helpful so long as we're still maintaining conversion scripts. But it's full of holes, too: Section 5's "Documentation of common conversions and start points" is a list of broken links.

Should we be guiding visitors to run make doc? If so, what documentation should we be providing in that build now?

Should we add a warning / caution in our README that some of the contents generated by make doc are obsolete?

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

No branches or pull requests

1 participant