Skip to content

Conversation

alanmcruickshank
Copy link
Member

As discussed in the maintainers meet the other week, this creates a "Guides and Howtos" section.

What used to be the Development section, has now been nested within the Guides section as a Contributing section.

There are also some bigger additions to those guides:

  • a guide on how to edit the docs, which I made more as a lookup for myself to remind me what options are available for cross referencing and suchlike in .rst files.
  • I've migrated across the last two pieces of the wiki (both of which are pretty meaty additions), mostly where I've just lifted and shifted because people weren't aware of the wiki but the content is still very useful:
  • Some of the python API bits which were in the development section before are now in an Internals section of the Reference docs.

I've set up readthedocs so that it builds this branch for now, so feel free to have a look at the built preview version of this: https://docs.sqlfluff.com/en/ac-docs_guides/ (it's probably much easier to review the built version than the raw rst code).

Copy link
Contributor

github-actions bot commented Oct 6, 2024

Coverage Results ✅

Name    Stmts   Miss  Cover   Missing
-------------------------------------
TOTAL   18455      0   100%

236 files skipped due to complete coverage.

Copy link
Contributor

@greg-finley greg-finley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@greg-finley greg-finley added this pull request to the merge queue Oct 8, 2024
Merged via the queue into main with commit 2088f4c Oct 8, 2024
29 checks passed
@greg-finley greg-finley deleted the ac/docs_guides branch October 8, 2024 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants