SEAPATH - Documentation Support

[ebail]

Request category

Project websites

Why is this needed?

SEAPATH wiki using confluence has some limitations:

• the formatting is limited
• the edition is not very open specially regarding external contributions requesting certain rights
• modern C/ CD tools could not be used to review / test / push documentation modification.

We would need the assistance of LF Energy to help moving our documentation for an other solution.

Following solutions could be considered:

• https://github.com/just-the-docs/just-the-docs
• https://about.readthedocs.com/

Ex: https://power-grid-model.readthedocs.io/en/stable/

This documentation refresh would facilitate the on-boarding of people and the adoption of SEAPATH.

When is this needed by?

Before dtech 2026

What are the projected costs for this?

N/A

What else should the TAC and Governing Board know about this request

N/A

[jmertic]

Thank you for this @ebail! It seems here that the need isn't documentation writing support, but more of help in migrating documentation to a different platform; is that accurate? Thanks!

[jmertic]

@ebail Following up - can you confirm if the need is just documentation migration? Thanks!

[ebail]

Hi @jmertic. Yes you are right. The documentation content was refactored. So we should be ok on that.
Maybe some help to highlight some content. Thanks

[jmertic]

Got it - thanks. Should we close this for now while you re-scope your needs? Let me know...

[ebail]

Hi @jmertic I think that support for migration would be required. The plan defined with Alex was to rework the content and then use third party help to migrate the content.

[jmertic]

Hi @ebail - I used https://github.com/Spenhouet/confluence-markdown-exporter to do a Confluence to markdown conversation. Could I create a new repo under https://github.com/seapath with the output for you to review?

[ebail]

Yes sure :)
Could you create a private repo on SEAPATH. I would not prefer to make it public for the moment ;)

Thanks

[jmertic]

Sure thing! See https://github.com/seapath/docs

[ebail]

That looks great :). We will review it.
Then the idea would be to render that into a dedicated website, right ?