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

Ambiguous meaning of "Source" in the documentation #42

Closed
gallandarakhneorg opened this issue Mar 21, 2014 · 4 comments
Closed

Ambiguous meaning of "Source" in the documentation #42

gallandarakhneorg opened this issue Mar 21, 2014 · 4 comments
Assignees
Milestone

Comments

@gallandarakhneorg
Copy link
Member

When opening the SARL documentation on www.sarl.io, we can see the "Spec" and "Source" tabs.

The meaning of "Source" may be ambiguous because the visitor may consider that it contains the source code of the tutorial example. She/he may be disappointed to obtain the code of the documentation specification (e.g. oral comment by @gbasso).

Is it possible to change the skin of the SARL documentation to avoid this problem?

@srodriguez
Copy link
Member

That is actually generated by Jnario which we use to ensure the examples are tested.
AFAIK you can't change that via a Jnario config. We could however change it in the site generation in the same way we add the site's navbar.

I think it is interesting to be able to see the "Doc's spec and source".

What do you suggest, change tab's text or remove the second tab?

@gallandarakhneorg
Copy link
Member Author

I think that removing the tabs is safe: the "Source" tab is interesting for the SARL's developers only, and the spec-source's syntax may difficult to understand for the others and not very useful.
In think that only the first tab ("Spec") will be really used by the SARL users.

@gallandarakhneorg
Copy link
Member Author

The pull request sebastianbenz/Jnario#121 is providing source code patches that permits to hide the tabs from the Jnario Maven plugin's configuration.

@gallandarakhneorg
Copy link
Member Author

@srodriguez seems to change the CSS for removing these tabs. That's great!

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

No branches or pull requests

2 participants