Chainlit / chainlit

Build Conversational AI in minutes ⚡️
https://docs.chainlit.io
Apache License 2.0
6.06k stars 777 forks source link

Welcome page is not shown on the main page anymore. #1073

Open inrsta opened 3 weeks ago

inrsta commented 3 weeks ago

Describe the bug Usually if you modify the chainlit.md on the root directory of the project it serves as the Welcome Page. With the new update, this markdown is hidden under the sidebar, under the button Readme.

To Reproduce Steps to reproduce the behavior:

Install chainlit with pip install chainlit Create a new empty directory Create a file demo.py with the content:

import chainlit as cl

@cl.step(type="tool")
async def tool():
    # Fake tool
    await cl.sleep(2)
    return "Response from the tool!"

@cl.on_message  # this function will be called every time a user inputs a message in the UI
async def main(message: cl.Message):
    """
    This function is called every time a user inputs a message in the UI.
    It sends back an intermediate response from the tool, followed by the final answer.

    Args:
        message: The user's message.

    Returns:
        None.
    """

    final_answer = await cl.Message(content="").send()

    # Call the tool
    final_answer.content = await tool()

    await final_answer.update()

Run with chainlit run demo.py -w

Expected behavior The Welcome Page text, which is part of the chainlit.md file, should appear when the website loads.

Screenshots

image

Desktop (please complete the following information):

hayescode commented 3 weeks ago

Ideally we'd be able to have markdown + starters. My guess is that is complicated so the markdown was simply removed.