willmcgugan / faqtory Goto Github PK

A frustrating thing about GitHub repositories is that GitHub have https://github.com/robots.txt configure such that only the contents of README.md can be crawled by search engines such as Google.

All other files in the repo - including FAQ.md - are blocked from being crawled!

See here:

• community/community#20958

The two potential solutions I can see for this are:

• Include configuration for publishing a copy of the FAQ using GitHub Pages, which can be indexed by search engine crawlers
• Move the built FAQ content into the README itself

How do I set this up in my Github repositories?

Currently the example workflow uses read-file-action to expose the suggestion to the step that creates the comment. However GitHub actions can do this natively using the $GITHUB_OUTPUT environment file https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter

- name: Run Suggest
  id: suggest
  run: |
    echo 'content<<EOF' >> $GITHUB_OUTPUT
    faqtory suggest "${{ github.event.issue.title }}" >> $GITHUB_OUTPUT
    echo 'EOF' >> $GITHUB_OUTPUT

Untested but I think that's how it would work.

test

Happy user of faqtory here.

Several times I had had to "hack" its usage to be able to organize my FAQ in "sections" like a section for questions about install, then one for those about development...

Do you think this woukd be something that could be desirable / implemented ?

Maybe it is already possible but I have not figured it out yet.

Either way am happy to open a pr to update the doc if it is already possible and or to update the code if it is not.

I don't think it's possible to use faqtory in a textual app due to conflicting rich requirements.