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

Generate our docs to a separate website #340

Open
t-persson opened this issue Dec 15, 2022 · 1 comment
Open

Generate our docs to a separate website #340

t-persson opened this issue Dec 15, 2022 · 1 comment

Comments

@t-persson
Copy link
Contributor

t-persson commented Dec 15, 2022

Description

We should generate and host our documentation on a separate website so that the documentation is more easily available.
Similar to what's done with cdevents(https://cdevents.dev/docs/)

Motivation

More professional and easier than linking directly to a github repository.

Exemplification

Whenever I want to send people to know more about Eiffel I tend to give them a link to Sepia and github. This is not a good introduction to the technical side of Eiffel.

Benefits

Eiffel documentation is more easily available for others.

Possible Drawbacks

The hosting and making sure it is up to date. Automation is required.

@t-persson t-persson assigned t-persson and unassigned t-persson Dec 15, 2022
@m-linner-ericsson
Copy link
Member

When looking at this do take a look at https://jamstack.org/generators/ to see if we can use something there.

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

No branches or pull requests

2 participants