[Feature Request] Documentation

[Shubham-Rasal]

Feature Request

I think documentation should have it's own place rather than a directory in the github repo.

Describe the desired solution

The idea is to move the documentation on a separate website, with clear navigation.

Describe possible alternatives

I would suggest we use Mintify or similar for structuring the documentation.

Additional context

I have been working on a side project using firecracker and find it difficult to navigate the docs dir. Although being comprehensive, the docs lack cohesivity.

I am willing to take up this effort, as it is a long-term commitment and could easily take more than a few weeks to update fully.

Checks

• Have you searched the Firecracker Issues database for similar requests?
• Have you read all the existing relevant Firecracker documentation?
• Have you read and understood Firecracker's core tenets?

[Shubham-Rasal]

@JackThomson2 what do you think?

[xmarcalx]

Hi @Shubham-Rasal ,

Thank you very much for your inputs and your interest in Firecracker.

We do actually prefer to maintain the documentation together with the code because it helps us to keep it up to date.
We basically can update the documentation together with code changes in PRs.

I think the point on having a better mechanism to navigate through it is valid. Which problem specifically you identified?
Would an index of our documentation for example into our README help you to better navigate and find the desired info?

[Shubham-Rasal]

Would an index of our documentation for example into our README help you to better navigate and find the desired info?

This would suffice. Here's the proposal -

• keep all the links to demos and examples in the main README.md itself.
• update the links to point to common resources