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

Update index.md #30

Open
kirillbobyrev opened this issue Apr 6, 2021 · 10 comments · May be fixed by #83
Open

Update index.md #30

kirillbobyrev opened this issue Apr 6, 2021 · 10 comments · May be fixed by #83
Labels
enhancement New feature or request

Comments

@kirillbobyrev
Copy link
Member

kirillbobyrev commented Apr 6, 2021

The index page looks empty and is not really useful for understanding what Clangd is/how it helps you. Completion is cool but does not advertise Clangd much from the first sight (compiler and Clang-Tidy diags + rename might do that). We can either:

  1. Update it: add more info and a couple of interactive demos, link "Features" (this is what most users would be interested in anyway, right?)
  2. Point index to the features directly and call it differently/make it "index-aware" (assume this is the first page users land on).
@kirillbobyrev kirillbobyrev added the enhancement New feature or request label Apr 6, 2021
@kirillbobyrev kirillbobyrev self-assigned this Apr 6, 2021
@kirillbobyrev
Copy link
Member Author

@sam-mccall @kadircet WDYT?

@kadircet
Copy link
Member

kadircet commented Apr 7, 2021

yes, that definitely SGTM!

@kirillbobyrev
Copy link
Member Author

yes, that definitely SGTM!

which one do you prefer, 1 or 2?

@kadircet
Copy link
Member

kadircet commented Apr 7, 2021

ah sorry they both felt like the same thing at first glance.

I suppose having a page which describes features at a glance, with links to pages with more details whenever possible would be great. (i think that's what you mean by first option)

If we can generate such a page automatically (i suppose that's what you mean by the second one?), that would be even better. i am just unaware if there are any solutions offered by github-pages for such a thing though, and i am not sure if it would be worth chasing something more complex.

So I'd definitely opt for first one, unless there's an easy solution for the second.

@Palaksharma23
Copy link

Is this issue still open can i take up this issue ?

@kirillbobyrev
Copy link
Member Author

@Palaksharma23 yes, I am not aware of the progress for it, you can definitely take it up! Feel free to add me as a reviewer for the PRs.

@wusatosi
Copy link

wusatosi commented May 2, 2023

It may actually make sense for the index page be the same as the features page.

@kirillbobyrev kirillbobyrev removed their assignment May 2, 2023
@kirillbobyrev
Copy link
Member Author

It may actually make sense for the index page be the same as the features page.

I don't think it should be exactly the same page as the features simply because feature overview doesn't explain what clangd is at all and goes directly into details. But overall, yes, I think it should be possible to just merge two of them.

@wusatosi
Copy link

wusatosi commented May 3, 2023

It may actually make sense for the index page be the same as the features page.

I don't think it should be exactly the same page as the features simply because feature overview doesn't explain what clangd is at all and goes directly into details. But overall, yes, I think it should be possible to just merge two of them.

Yeah, merging them sounds like a good idea, will {% include features.md %} on index.md work?
I can submit a pr if this is good enough.

@wusatosi wusatosi linked a pull request May 4, 2023 that will close this issue
@wusatosi
Copy link

wusatosi commented May 4, 2023

It may actually make sense for the index page be the same as the features page.

I don't think it should be exactly the same page as the features simply because feature overview doesn't explain what clangd is at all and goes directly into details. But overall, yes, I think it should be possible to just merge two of them.

Hi, @kirillbobyrev , I did a proof of concept at #83 . Have a look and tell me what do you think!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants